modifed some example scripts; added defrevs.py to examples dir; dropped typedefs.py from examples dir; regenerated html docs

Author: klehman-rally

doc/build/doctrees/environment.pickle

@@ -142,7 +142,7 @@ The priority chain consists of these steps:
         - RALLY_SERVER
         - RALLY_USER
         - RALLY_PASSWORD
-        - RALLY_APIKEY
+        - APIKEY
         - RALLY_WORKSPACE
         - RALLY_PROJECT
     * if present, use information from a rally-<version>.cfg file in the current directory,

doc/build/doctrees/interface.doctree

@@ -201,7 +201,7 @@ <h1>rallyWorkset<a class="headerlink" href="#rallyworkset" title="Permalink to t
 <li>RALLY_SERVER</li>
 <li>RALLY_USER</li>
 <li>RALLY_PASSWORD</li>
-<li>RALLY_APIKEY</li>
+<li>APIKEY</li>
 <li>RALLY_WORKSPACE</li>
 <li>RALLY_PROJECT</li>
 </ul>

doc/build/html/_sources/interface.txt

@@ -0,0 +1,45 @@
+#!/usr/bin/env python
+
+#################################################################################################
+#
+#  defrevs -- show the revisions for a specific defect
+#
+USAGE = """
+python defrevs [CONFIG] <Defect_FormattedID>
+
+   where CONFIG is either command line arguments or the 
+   specification of a file containing pyral related config info
+"""
+#################################################################################################
+
+import sys, os
+from pyral import Rally, rallyWorkset
+
+#################################################################################################
+
+def main(args):
+    options = [opt for opt in args if opt.startswith('--')]
+    args    = [arg for arg in args if arg not in options]
+    server, user, password, apikey, workspace, project = rallyWorkset(options)
+    rally = Rally(server, user, password, apikey=apikey, workspace=workspace, project=project)
+    
+    target   = args.pop(0)
+    fields   = "FormattedID,State,Name,CreationDate,RevisionHistory,Revisions"
+    criteria = "FormattedID = %s" % target 
+
+    defect = rally.get('Defect', fetch=fields, query=criteria, instance=True)
+
+    print "%s  %10.10s  %-11s  %s" % (defect.FormattedID, defect.CreationDate, 
+                                      defect.State, defect.Name)
+    print ""
+    for rev in reversed(defect.RevisionHistory.Revisions):
+        print "%d) %-22.22s %-16.16s %s\n" % \
+              (rev.RevisionNumber, rev.CreationDate.replace('T', ' '), 
+               rev.User.DisplayName, rev.Description)
+
+#################################################################################################
+#################################################################################################
+
+if __name__ == '__main__':
+    main(sys.argv[1:])
+    sys.exit(0)

doc/build/html/interface.html

@@ -82,15 +82,7 @@ def main(args):
         sys.exit(5)
 
     for item in response:
-        for attr in COMMON_ATTRIBUTES:
-            print "    %-16.16s : %s" % (attr, getattr(item, attr))
-        attrs = [attr for attr in item.attributes() if attr not in COMMON_ATTRIBUTES]
-        for attr in sorted(attrs):
-            attribute = getattr(item, attr) 
-            cn = attribute.__class__.__name__
-            if cn[0] in string.uppercase:
-                attribute = attribute.Name if cn != 'NoneType' else None
-            print "    %-16.16s : %s" % (attr, attribute)
+        print item.details()
 
 #################################################################################################
 #################################################################################################

doc/build/html/searchindex.js

@@ -25,7 +25,7 @@ def main(args):
     for workspace in rally.getWorkspaces():
         print "%s %s" % (workspace.oid, workspace.Name)
         for project in rally.getProjects(workspace=workspace.Name):
-            print "    %12.12s  %s" % (project.oid, project.Name)
+            print "    %12.12s  %-36.36s   |%s|" % (project.oid, project.Name, project.State)
         print ""
 
 #################################################################################################

examples/defrevs.py

@@ -79,8 +79,7 @@ def showRepoItems(rally, repo_name, workspace=None, limit=200, order="ASC", sinc
     criteria = by_repo
     if since_date:
         date_cond = "CommitTimestamp >= %s" % since_date
-        criteria = "((%s) and (%s))" % (by_repo, date_cond)
-
+        criteria = [by_repo, date_cond]
 
     try:
         response = rally.get('Changeset', fetch=True, 

examples/getitem.py

@@ -25,7 +25,7 @@ def main(args):
         rally = Rally(server, user=username, password=password, workspace=workspace, project=project)
     rally.enableLogging("rally.history.showdefects")
 
-    fields    = "FormattedID,State,Name,Severity,Priority", 
+    fields    = "FormattedID,State,Name,Severity,Priority"
     criterion = 'State != Closed'
 
     response = rally.get('Defect', fetch=fields, query=criterion, order="FormattedID",