Merge pull request #35 from klehman-rally/master

1.1.0 release supporting Rally API Key and a few minor defect fixes

Author: klehman-rally

README.rst

@@ -6,7 +6,7 @@ The `pyral <http://github.com/RallyTools/RallyRestToolkitForPython>`_ package en
 and otherwise wrangle the data in your Rally subscription using the popular
 and productive Python language.
 The ``pyral`` package provides a smooth and easy to use veneer on top
-of the Rally REST Web Services API using the JSON flavored variant.
+of the Rally REST Web Services API using JSON.
 
 .. contents::
 
@@ -34,6 +34,7 @@ Obtain the requests_ package and install it according to that package's directio
 As of requests-2.0.0, there is support for HTTPS over HTTP proxy via the CONNECT request.
 Use of requests-2.x or better is recommended for use with pyral.
 The requests_ package can be found via the Python Package Index site (http://pypi/python.org/index).
+The most recent release of pyral (1.1.0) has been tested using requests 2.3.0.
 
 
 Unpack the ``pyral`` distribution file (zip or tar.gz) and then install the pyral_ package. 
@@ -59,7 +60,7 @@ relevant packages.
    >> import requests
    >> import pyral
    >> pyral.__version__
-   (1, 0, 1)
+   (1, 1, 0)
 
 
 
@@ -95,10 +96,10 @@ Sample code
 Common setup code ::
 
   import sys
-  from pyral import Rally, rallySettings
+  from pyral import Rally, rallyWorkset
   options = [arg for arg in sys.argv[1:] if arg.startswith('--')]
   args    = [arg for arg in sys.argv[1:] if arg not in options] 
-  server, user, password, workspace, project = rallySettings(options)
+  server, user, password, apikey, workspace, project = rallyWorkset(options)
   rally = Rally(server, user, password, workspace=workspace, project=project)
   rally.enableLogging('mypyral.log')
 
@@ -226,6 +227,7 @@ create an instance of the Rally class.
   SERVER                               Rally server (example rally1.rallydev.com)
   USER                                 Rally subscription UserName value
   PASSWORD                             password for the Rally subscription UserName
+  APIKEY                               Rally API Key value
   WORKSPACE                            Rally Workspace
   PROJECT                              Rally Project
 ====================================== =========================================
@@ -243,6 +245,7 @@ The item names in config files **are** case sensitive.
   --cfg=<config_file_name>              ditto
   --rallyUser=<foo>                     your Rally UserName
   --rallyPassword=<bar>                 password associated with the Rally UserName
+  --apikey=<APIKey>                     valid Rally API Key value
   --rallyWorkspace=<bar>                Workspace in Rally you want to interact with
   --rallyProject=<bar>                  Project in Rally you want to interact with
 ====================================== =========================================
@@ -252,85 +255,98 @@ Prerequisites
 -------------
 
  * Python 2.6 or 2.7 (2.7 is preferred)
- * The requests_ package, 2.0.0 or better (2.0.0 finally includes support for https proxy)
+ * The requests_ package, 2.0.0 or better (2.0.0 finally includes support for https proxy),
+   requests 2.3.0 is recommended.
 
 .. _requests: http://github.com/kennethreitz/requests
 
 Versions
 --------
 
-   * 1.0.1 - Patch to address defect with Rally WSAPI v2.0 projects collection endpoint
-             providing conflicting information.
-
-   * 1.0.0 - 
-            Default WSAPI version in config is v2.0. This version is not compatible 
-            with Rally WSAPI version 1.x.  
-            Adjusted the RallyUrlBuilder (via RallyQueryFormatter) to be more resilient
-            with respect to many more "special" characters (non-alphanumeric).
-            Retrieving the meta data uses the v2.0 schema endpoint.
-            No longer support a version keyword argument when obtaining a Rally instance.
-
-   * 0.9.4 -
-            Adjusted Rally __init__ to accommodate using requests 0.x, 1.x, 2.x versions.
-            Factored out query building and fixed constructing multi condition queries.
-            Added internal convenience method to handle a list of refs to turn them into a
-            list of single key (_ref) hashes.
-            Added UserIterationCapacity to known entities.
-            Upped default WSAPI version in config to 1.43
-            Support using of https_proxy / HTTPS_PROXY environment variables.
-            Refactored getAllUsers to include UserProfile information with fewer queries.
-
-   * 0.9.3 -
-            Fixed Pinger class to use correct ping options on Linux and Windows
-            Updated exception catching and exception raising to Python 2.6/2.7 syntax.            
-
-   * 0.9.2 -  
-            Fixed getProject to take optional project name argument.
-            Added HTTP header item in config.py to set Content-TYpe to 'application/json'.
-            Added recognition of verify_ssl_cert=True/False as keyword argment to
-            Rally constructor.  Explicit specification results in passing a
-            verify=True/False to the underlying requests package. This can be
-            useful when dealing with an expired SSL certificate.
-            Upped default WSAPI version in config.py to 1.37 to support dyna-types
-            (specifically PortfolioItem and sub-types)..
-            Modified addAttachment to conform with non-backward compatible change in Rally WSAPI 
-            involving how an attachment is related to an artifact.
-            Fixed defect in calculating an Attachment file size (use pre-encoded rather than post-encoded size).
-
-            This release is intended as the final beta before a 1.0 release.
-
-   * 0.9.1 -  
-            Upped default WSAPI version in config.py to 1.30
-            All entities that are subclasses of WorkspaceDomainObject now have a details method
-            that show the attribute values in an easy to read multiline format.
-            Dropped attempted discrimination of server value to determine if it is a name or an IPv4 address    No longer look for http_proxy in environment, only https_proxy.
-            Introduced convenience methods dealing with attachments.
-            Corrected resource URL construction for the major ops (GET, PUT, POST, DEL)
-            when project=None specified (useful for Workspace spanning activities).
-
-   * 0.8.12 - Fixed premature exercise of iterator in initial response
+   1.1.0 
+       Introduction of support to use Rally API Key and rallyWorkset (supercedes rallySettings). 
+       Two relatively minor defects fixed dealing with internalizing environment
+       vars for initialization and in retrieving Rally entity attribute allowed values.
+
+   1.0.1
+       Patch to address defect with Rally WSAPI v2.0 projects collection endpoint
+       providing conflicting information.
+
+   1.0.0
+       Default WSAPI version in config is v2.0. This version is not compatible 
+       with Rally WSAPI version 1.x.  
+       Adjusted the RallyUrlBuilder (via RallyQueryFormatter) to be more resilient
+       with respect to many more "special" characters (non-alphanumeric).
+       Retrieving the meta data uses the v2.0 schema endpoint.
+       No longer support a version keyword argument when obtaining a Rally instance.
+
+   0.9.4
+       Adjusted Rally __init__ to accommodate using requests 0.x, 1.x, 2.x versions.
+       Factored out query building and fixed constructing multi condition queries.
+       Added internal convenience method to handle a list of refs to turn them into a
+       list of single key (_ref) hashes.
+       Added UserIterationCapacity to known entities.
+       Upped default WSAPI version in config to 1.43.
+       Support using of https_proxy / HTTPS_PROXY environment variables.
+       Refactored getAllUsers to include UserProfile information with fewer queries.
+
+   0.9.3
+       Fixed Pinger class to use correct ping options on Linux and Windows.
+       Updated exception catching and exception raising to Python 2.6/2.7 syntax.            
+
+   0.9.2
+       Fixed getProject to take optional project name argument.
+       Added HTTP header item in config.py to set Content-Type to 'application/json'.
+       Added recognition of verify_ssl_cert=True/False as keyword argment to
+       Rally constructor.  Explicit specification results in passing a
+       verify=True/False to the underlying requests package. This can be
+       useful when dealing with an expired SSL certificate.
+       Upped default WSAPI version in config.py to 1.37 to support dyna-types
+       (specifically PortfolioItem and sub-types).
+       Modified addAttachment to conform with non-backward compatible change in Rally WSAPI 
+       involving how an attachment is related to an artifact.
+       Fixed defect in calculating an Attachment file size (use pre-encoded rather than post-encoded size).
+
+       This release is intended as the final beta before a 1.0 release.
+
+   0.9.1
+       Upped default WSAPI version in config.py to 1.30
+       All entities that are subclasses of WorkspaceDomainObject now have a details method
+       that show the attribute values in an easy to read multiline format.
+       Dropped attempted discrimination of server value to determine if it is a name or an IPv4 address.
+       No longer look for http_proxy in environment, only https_proxy.
+       Introduced convenience methods dealing with attachments.
+       Corrected resource URL construction for the major ops (GET, PUT, POST, DEL)
+       when project=None specified (useful for Workspace spanning activities).
+
+   0.8.12
+       Fixed premature exercise of iterator in initial response
 
-   * 0.8.11 -
-            Fixed inappropriate error message when initial connect attempt timed out. 
-            Message had stated that the target server did not speak the Rally WSAPI.  
-            Improved context handling with respect to workspace and project settings.
+   0.8.11
+       Fixed inappropriate error message when initial connect attempt timed out. 
+       Message had stated that the target server did not speak the Rally WSAPI.  
+       Improved context handling with respect to workspace and project settings.
 
-   * 0.8.10 - 
-            Attempted to bolster proxy handling.  
-            Limited success as there is an outstanding issue in equests (urllib3) not 
-            implementing CONNECT for https over http.
+   0.8.10
+       Attempted to bolster proxy handling.  
+       Limited success as there is an outstanding issue in requests (urllib3) not 
+       implementing CONNECT for https over http.
 
-   * 0.8.9 -  initial attempt at providing proxy support
+   0.8.9
+       initial attempt at providing proxy support
 
-   * 0.8.8 -  added warn=True/False to Rally instantiation
+   0.8.8  
+       added warn=True/False to Rally instantiation
+
+   0.8.7
+       Initial release on developer.rallydev.com
 
-   * 0.8.7 -  Initial release on developer.rallydev.com
 
 TODO
 ----
-* Python 3.3+ support
-
+* Rework the distribution to be pip installable
 * Dynamically construct the Rally schema hierarchy economically.
+* Python 3.3+ support
 
 
 License

README.short

@@ -20,6 +20,7 @@ Requirements
 The pyral package requires the use of Kenneth Reitz's requests package using version 2.0.0 or better.
 As of requests version 2.0.0, there is support for HTTPS over HTTP proxy via the CONNECT request.
 The requests package can be found via the Python Package Index site (http://pypi/python.org/index).
+The most recent release of pyral (1.1.0) has been tested with requests 2.3.0.
 
 
 Installation

VERSIONS

@@ -60,3 +60,9 @@
 1.0.1 - June 2014
     Patch to address flaw in WSAPI v2.0 projects collection endpoint having a mismatch between TotalResultCount and
     actual information about projects.    
+
+1.1.0 - August 2014
+    Introduction of support for Rally API Key, along with rallyWorkset convenience method to superced rallySettings. 
+    Defects fixed related to internalizing environment in rallySettings (and rallyWorkset) 
+      and in getting allowed values for Rally types.
+

build_dist.py

@@ -11,7 +11,7 @@
 import zipfile
 
 PACKAGE_NAME = "pyral"
-VERSION      = "1.0.1"
+VERSION      = "1.1.0"
 
 AUX_FILES  = ['MANIFEST.in', 
               'LICENSE', 
@@ -34,7 +34,8 @@
               'builddefs.py',
               'creattach.py',
               'get_attachments.py',
-              'add_tcrs.py'
+              'add_tcrs.py',
+              'defrevs.py'
              ]
 DOC_FILES  = ['doc/Makefile',
               'doc/source/conf.py',
@@ -150,4 +151,3 @@ def make_zipfile(pkg_name, pkg_version, base_files, example_files, doc_files):
 if __name__ == "__main__":
     main(sys.argv[1:])
 
-

dists/pyral-1.1.0.tar.gz

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 7f5c0220ef33b0dea345e5da52939890
+config: e6fa1aa9fa108f8722de9168080d36dc
 tags: 645f666f9bcd5a90fca523b33c5a78b7