Merge pull request #98 from klehman-rally/master

accommodate fully qualified Project name to disambiguate duplicately named projects, fix minor bug not using MAX_PAGESIZE universally.

MANIFEST

@@ -29,3 +29,5 @@ examples/defrevs.py
 examples/add_tcrs.py
 examples/updtag.py
 examples/addtags.py
+examples/allowedValues.py
+examples/get_milestones.py

PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 1.1
 Name: pyral
-Version: 1.2.1
+Version: 1.2.2
 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/dist/pyral-1.2.1.zip
+Download-URL: https://github.com/RallyTools/RallyRestToolkitForPython/raw/master/dist/pyral-1.2.2.zip
 Description: This is the README file for pyral, a package implementing a 
         Pythonic interface to the Rally REST API
 
@@ -28,7 +28,7 @@ Description: This is the README file for pyral, a package implementing a
         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 most recent release of pyral (1.2.2) has been tested with requests 2.8.1.
         The six module is also required.
 
 

README.rst

@@ -39,7 +39,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.2.1) has been tested using requests 2.8.1.
+The most recent release of pyral (1.2.2) has been tested using requests 2.8.1.
 
 Obtain and install the six_ module (available from PyPI at https://pypi.python.org/pypi/six)
 
@@ -67,7 +67,7 @@ relevant packages.
    >> import requests
    >> import pyral
    >> pyral.__version__
-   (1, 2, 1)
+   (1, 2, 2)
 
 
 
@@ -274,6 +274,12 @@ Prerequisites
 Versions
 --------
 
+   **1.2.2**
+       Allow for disambiguating Project amongst name duplications by means of using fully qualified path.
+       Incorporated suggestion on preserving case name of custom PortfolioItem sub-item.
+       Fixed discrepancy of docs versus code on default pagesize, now is actually 200 everywhere.
+       Fix location of download package in GitHub repo.
+
    **1.2.1**
        Added mention that the six package is required.
        Fixed context setup for proper handling when a user has no default workspace/project settings.

README.short

@@ -20,7 +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.2.1) has been tested with requests 2.8.1.
+The most recent release of pyral (1.2.2) has been tested with requests 2.8.1.
 The six module is also required.
 
 

build_dist.py

@@ -9,10 +9,11 @@
 import sys, os
 import tarfile
 import zipfile
+import shutil
 import re
 
 PACKAGE_NAME = "pyral"
-VERSION      = "1.2.1"
+VERSION      = "1.2.2"
 
 AUX_FILES  = ['MANIFEST.in', 
               'PKG-INFO', 
@@ -37,6 +38,7 @@
               'builddefs.py',
               'creattach.py',
               'get_attachments.py',
+              'get_milestones.py',
               'get_schedulable_artifacts.py',
               'add_tcrs.py',
               'defrevs.py',
@@ -100,6 +102,24 @@ def main(args):
         reduction_pct = int(reduction_fraction * 100)
         print("%-52.52s   %6d (%2d%%)" % (info.filename, info.compress_size, reduction_pct))
 
+    # got to use Python 2.7 to be able to run python setup.py bdist_wheel
+    os.system('/usr/local/bin/python setup.py bdist_wheel')
+    wheel_file = "pyral-%s-py2.py3-none-any.whl" % VERSION
+    # the wheel_file gets written into the dist  subdir by default, no need for a copy...
+
+    store_packages('dist',  [tarball])
+    store_packages('dists', [tarball, zipped])
+
+################################################################################
+
+def store_packages(subdir, files):
+    for file in files:
+        if os.path.exists(file):
+            shutil.copy(file, '%s/%s' % (subdir, file))
+        else:
+            problem = "No such file found: {0} to copy into {1}".format(file, subdir)
+            sys.stderr.write(problem)
+
 ################################################################################
 
 def package_meta(filename):

doc/build/html/.buildinfo

@@ -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: 62325dc5575a032c598ed35259d4cf4f
+config: 1c8ead5262c9c247959f836aa7c0efdf
 tags: 645f666f9bcd5a90fca523b33c5a78b7

doc/build/html/_sources/interface.txt

@@ -324,6 +324,12 @@ To instantiate a Rally object, you'll need to provide these arguments:
         **pyral**, you must have your account added to the whitelist in Rally so that you can use either
         BasicAuth (username and password) or the API Key to authenticate to Rally.
 
+.. note::
+
+        As of the 1.2.2 release, **pyral** offers a means of precisely identifying a Project whose name appears in multiple locations within the forest of Projects with a Workspace.  For example, your organization may have several "base" level Projects with sub-trees of Projects.  In this scenario, you might have multiple Projects named 'AgileTeam-X' or 'SalesPrep'.  By using a Project path component separator of '  // ' (<space><slash><slash><space>) you can specify the unambiguous and unique path to the specific Project of interest.  Example:  Omnibus // Metallic // Conductive // Copper // Wire . 
+        You only have to use this syntax to specify a particular Project if you have multiple instances of that Project that have the same name.  There is no provision for supporting the scenario where a Project of the same name exists in the same structural location. 
+
+
 .. py:class:: Rally (server, user=None, password=None, apikey=None, workspace=None, project=None, warn=True, server_ping=True)
 
 Examples::

doc/build/html/genindex.html

@@ -9,7 +9,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Index &mdash; pyral 1.2.1 documentation</title>
+  <title>Index &mdash; pyral 1.2.2 documentation</title>
 
 
 
@@ -34,7 +34,7 @@
         <link rel="index" title="Index"
               href="#"/>
         <link rel="search" title="Search" href="search.html"/>
-    <link rel="top" title="pyral 1.2.1 documentation" href="index.html"/> 
+    <link rel="top" title="pyral 1.2.2 documentation" href="index.html"/> 
 
 
   <script src="_static/js/modernizr.min.js"></script>
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                1.2.1
+                1.2.2
               </div>
 
 
@@ -437,7 +437,7 @@ <h2 id="U">U</h2>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.2.1',
+            VERSION:'1.2.2',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

doc/build/html/index.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Python toolkit for the Rally REST API &mdash; pyral 1.2.1 documentation</title>
+  <title>Python toolkit for the Rally REST API &mdash; pyral 1.2.2 documentation</title>
 
 
 
@@ -33,7 +33,7 @@
         <link rel="index" title="Index"
               href="genindex.html"/>
         <link rel="search" title="Search" href="search.html"/>
-    <link rel="top" title="pyral 1.2.1 documentation" href="#"/>
+    <link rel="top" title="pyral 1.2.2 documentation" href="#"/>
         <link rel="next" title="Python toolkit for the Rally REST API" href="overview.html"/> 
 
 
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                1.2.1
+                1.2.2
               </div>
 
 
@@ -226,7 +226,7 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.2.1',
+            VERSION:'1.2.2',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

doc/build/html/interface.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Primary pyral classes and functions &mdash; pyral 1.2.1 documentation</title>
+  <title>Primary pyral classes and functions &mdash; pyral 1.2.2 documentation</title>
 
 
 
@@ -33,7 +33,7 @@
         <link rel="index" title="Index"
               href="genindex.html"/>
         <link rel="search" title="Search" href="search.html"/>
-    <link rel="top" title="pyral 1.2.1 documentation" href="index.html"/>
+    <link rel="top" title="pyral 1.2.2 documentation" href="index.html"/>
         <link rel="prev" title="Python toolkit for the Rally REST API" href="overview.html"/> 
 
 
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                1.2.1
+                1.2.2
               </div>
 
 
@@ -521,6 +521,11 @@ <h1>Rally<a class="headerlink" href="#rally" title="Permalink to this headline">
 <strong>pyral</strong>, you must have your account added to the whitelist in Rally so that you can use either
 BasicAuth (username and password) or the API Key to authenticate to Rally.</p>
 </div>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">As of the 1.2.2 release, <strong>pyral</strong> offers a means of precisely identifying a Project whose name appears in multiple locations within the forest of Projects with a Workspace.  For example, your organization may have several &#8220;base&#8221; level Projects with sub-trees of Projects.  In this scenario, you might have multiple Projects named &#8216;AgileTeam-X&#8217; or &#8216;SalesPrep&#8217;.  By using a Project path component separator of &#8216;  // &#8216; (&lt;space&gt;&lt;slash&gt;&lt;slash&gt;&lt;space&gt;) you can specify the unambiguous and unique path to the specific Project of interest.  Example:  Omnibus // Metallic // Conductive // Copper // Wire .
+You only have to use this syntax to specify a particular Project if you have multiple instances of that Project that have the same name.  There is no provision for supporting the scenario where a Project of the same name exists in the same structural location.</p>
+</div>
 <dl class="class">
 <dt id="Rally">
 <em class="property">class </em><code class="descname">Rally</code><span class="sig-paren">(</span><em>server</em>, <em>user=None</em>, <em>password=None</em>, <em>apikey=None</em>, <em>workspace=None</em>, <em>project=None</em>, <em>warn=True</em>, <em>server_ping=True</em><span class="sig-paren">)</span><a class="headerlink" href="#Rally" title="Permalink to this definition">¶</a></dt>
@@ -1128,7 +1133,7 @@ <h1>Item Attributes<a class="headerlink" href="#item-attributes" title="Permalin
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.2.1',
+            VERSION:'1.2.2',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

doc/build/html/overview.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Python toolkit for the Rally REST API &mdash; pyral 1.2.1 documentation</title>
+  <title>Python toolkit for the Rally REST API &mdash; pyral 1.2.2 documentation</title>
 
 
 
@@ -33,7 +33,7 @@
         <link rel="index" title="Index"
               href="genindex.html"/>
         <link rel="search" title="Search" href="search.html"/>
-    <link rel="top" title="pyral 1.2.1 documentation" href="index.html"/>
+    <link rel="top" title="pyral 1.2.2 documentation" href="index.html"/>
         <link rel="next" title="Primary pyral classes and functions" href="interface.html"/>
         <link rel="prev" title="Python toolkit for the Rally REST API" href="index.html"/> 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                1.2.1
+                1.2.2
               </div>
 
 
@@ -326,7 +326,7 @@ <h1>Introduction of Dyna-Types<a class="headerlink" href="#introduction-of-dyna-
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.2.1',
+            VERSION:'1.2.2',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

doc/build/html/search.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Search &mdash; pyral 1.2.1 documentation</title>
+  <title>Search &mdash; pyral 1.2.2 documentation</title>
 
 
 
@@ -33,7 +33,7 @@
         <link rel="index" title="Index"
               href="genindex.html"/>
         <link rel="search" title="Search" href="#"/>
-    <link rel="top" title="pyral 1.2.1 documentation" href="index.html"/> 
+    <link rel="top" title="pyral 1.2.2 documentation" href="index.html"/> 
 
 
   <script src="_static/js/modernizr.min.js"></script>
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                1.2.1
+                1.2.2
               </div>
 
 
@@ -188,7 +188,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.2.1',
+            VERSION:'1.2.2',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true