doc adjustments, added PKG-INFO

Author: klehman-rally

PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 1.1
+Name: pyral
+Version: 1.2.1
+Summary: Python toolkit for Rally REST API
+Home-page: https://github.com/RallyTools/RallyRestToolkitForPython
+Author: Kip Lehman (Rally Software Development)
+License: BSD
+Download-URL: https://github.com/RallyTools/RallyRestToolkitForPython/raw/master/dists/pyral-1.2.1.zip
+Description: This is the README file for pyral, a package implementing a 
+        Pythonic interface to the Rally REST API
+        
+        Description
+        -----------
+        
+        The Rally REST Tookit for Python consists of a package that provides a means
+        to interact with entities and artifacts in your Rally subscription.  The full
+        spectrum of CRUD operations is available in your Rally Workspaces and Projects,
+        providing of course that your Rally subscription credentials enable you to perform
+         those operations.  The toolkit insulates the package user from having to make 
+        multiple requests to obtain the full set of qualifying items by performing any 
+        subsequent "page" requests automatically.  
+        An additional key feature is the ability to obtain entity sub fields
+        that may be references or collections via the familiar dot '.' notation.
+        
+        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.2.1) has been tested with requests 2.8.1.
+        The six module is also required.
+        
+        
+        Installation
+        ------------
+        
+        Once requests and six has been installed, run the setup.py program supplied with
+        this distribution as::
+        
+            python setup.py install
+        
+        Validation
+        ----------
+        
+        Copy the template.cfg file to a file named my.cfg.
+        Edit my.cfg.  Uncomment and replace the values for SERVER, USER, PASSWORD.
+        Leave the WORKSPACE and PROJECT entries commented out for now.
+        
+        Run the rallyfire.py program as:
+        
+        $ python rallyfire.py --config=my.cfg
+        
+        Documentation
+        -------------
+        
+        Obtain the zip file containing the HTML and CSS files comprising the document set for pyral.
+        Unzip in a suitable location and point your web browser to the doc/build/html/index.html file
+        
+          The rendered documentation is also available at http://pyral.readthedocs.io/en/latest/
+        
+        
+Keywords: rally,agilecentral,api
+Requires: six
+Requires: requests>=2.8.1
+Platform: any
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.6
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries

doc/build/doctrees/environment.pickle

@@ -266,21 +266,23 @@ Rally
     with appropriate and valid target/credential information then provides a means of 
     interacting with the Rally server.
 
-    To instantiate a Rally object, you'll need to provide these arguments:
-        * server
-        * user
-        * password
+To instantiate a Rally object, you'll need to provide these arguments:
+        * **server**    usually rally1.rallydev.com unless you are using an OnPrem version
+        * **user**      AgileCentral UserName
+        * **password**  AgileCentral password for the given user
 
     either in this specific order or as keyword arguments.
 
-    You must either have default workspace and project values set up for your account
+    You must either have default **workspace** and **project** values set up for your account
+
     OR 
-    you must provide workspace and project values that are valid and accessible for your account.
+
+    you must provide **workspace** and **project** values that are valid and accessible for your account.
 
     You can optionally specify the following as keyword arguments:
-        * apikey
-        * workspace
-        * project
+        * apikey      (alternate credential specification)
+        * workspace   (name of the AgileCentral workspace)
+        * project     (name of the AgileCentral project)
         * verify_ssl_cert  (True or False, default is True)
         * warn     (True or False, default is True) 
                     Controls whether a warning is issued if no project is specified

doc/build/doctrees/interface.doctree

@@ -439,30 +439,30 @@ <h1>rallySettings<a class="headerlink" href="#rallysettings" title="Permalink to
 <div class="section" id="rally">
 <h1>Rally<a class="headerlink" href="#rally" title="Permalink to this headline">¶</a></h1>
 <blockquote>
-<div><p>The Rally class is the central focus of the <strong>pyral</strong> package.  Instantiation of this class
+<div>The Rally class is the central focus of the <strong>pyral</strong> package.  Instantiation of this class
 with appropriate and valid target/credential information then provides a means of
-interacting with the Rally server.</p>
+interacting with the Rally server.</div></blockquote>
 <dl class="docutils">
 <dt>To instantiate a Rally object, you&#8217;ll need to provide these arguments:</dt>
-<dd><ul class="first last simple">
-<li>server</li>
-<li>user</li>
-<li>password</li>
+<dd><blockquote class="first">
+<div><ul class="simple">
+<li><strong>server</strong>    usually rally1.rallydev.com unless you are using an OnPrem version</li>
+<li><strong>user</strong>      AgileCentral UserName</li>
+<li><strong>password</strong>  AgileCentral password for the given user</li>
 </ul>
-</dd>
-</dl>
+</div></blockquote>
 <p>either in this specific order or as keyword arguments.</p>
-<p>You must either have default workspace and project values set up for your account
-OR
-you must provide workspace and project values that are valid and accessible for your account.</p>
+<p>You must either have default <strong>workspace</strong> and <strong>project</strong> values set up for your account</p>
+<p>OR</p>
+<p>you must provide <strong>workspace</strong> and <strong>project</strong> values that are valid and accessible for your account.</p>
 <dl class="docutils">
 <dt>You can optionally specify the following as keyword arguments:</dt>
 <dd><ul class="first last">
-<li><p class="first">apikey</p>
+<li><p class="first">apikey      (alternate credential specification)</p>
 </li>
-<li><p class="first">workspace</p>
+<li><p class="first">workspace   (name of the AgileCentral workspace)</p>
 </li>
-<li><p class="first">project</p>
+<li><p class="first">project     (name of the AgileCentral project)</p>
 </li>
 <li><p class="first">verify_ssl_cert  (True or False, default is True)</p>
 </li>
@@ -509,11 +509,12 @@ <h1>Rally<a class="headerlink" href="#rally" title="Permalink to this headline">
 </ul>
 </dd>
 </dl>
-<p>If you use an apikey value, any user name and password you provide is not considered, the connection
+<p class="last">If you use an apikey value, any user name and password you provide is not considered, the connection
 attempt will only use the apikey.
 Consult the Rally Help documentation for Rally Application Manager for information
 on how to generate an API Key and how to reset or delete an API Key.</p>
-</div></blockquote>
+</dd>
+</dl>
 <div class="admonition note">
 <p class="first admonition-title">Note</p>
 <p class="last">If your Subscription administrator has set up your Rally Subscription as &#8220;SSO only&#8221;, then to use

doc/build/html/_sources/interface.txt

@@ -266,21 +266,23 @@ Rally
     with appropriate and valid target/credential information then provides a means of 
     interacting with the Rally server.
 
-    To instantiate a Rally object, you'll need to provide these arguments:
-        * server
-        * user
-        * password
+To instantiate a Rally object, you'll need to provide these arguments:
+        * **server**    usually rally1.rallydev.com unless you are using an OnPrem version
+        * **user**      AgileCentral UserName
+        * **password**  AgileCentral password for the given user
 
     either in this specific order or as keyword arguments.
 
-    You must either have default workspace and project values set up for your account
+    You must either have default **workspace** and **project** values set up for your account
+
     OR 
-    you must provide workspace and project values that are valid and accessible for your account.
+
+    you must provide **workspace** and **project** values that are valid and accessible for your account.
 
     You can optionally specify the following as keyword arguments:
-        * apikey
-        * workspace
-        * project
+        * apikey      (alternate credential specification)
+        * workspace   (name of the AgileCentral workspace)
+        * project     (name of the AgileCentral project)
         * verify_ssl_cert  (True or False, default is True)
         * warn     (True or False, default is True) 
                     Controls whether a warning is issued if no project is specified