Merge pull request #94 from klehman-rally/master

pyral 1.2.1 release

Author: klehman-rally

MANIFEST

@@ -17,11 +17,15 @@ examples/showdefects.py
 examples/statecounts.py
 examples/crtask.py
 examples/uptask.py
-examples/typedefs.py
+examples/typedef.py
 examples/repoitems.py
 examples/wkspcounts.py
 examples/builddefs.py
 examples/creattach.py
 examples/get_attachments.py
+examples/get_schedulable_artifacts.py
 examples/get_schema.py
+examples/defrevs.py
 examples/add_tcrs.py
+examples/updtag.py
+examples/addtags.py

MANIFEST.in

@@ -1,27 +1,6 @@
-LICENSE
-README.short
-README.rst
-setup.py
-template.cfg
-rallyfire.py
-pyral/__init__.py
-pyral/config.py
-pyral/context.py
-pyral/entity.py
-pyral/hydrate.py
-pyral/rallyresp.py
-pyral/restapi.py
-examples/typedef.py
-examples/get_schema.py
-examples/periscope.py
-examples/getitem.py
-examples/showdefects.py
-examples/statecounts.py
-examples/wkspcounts.py
-examples/crtask.py
-examples/uptask.py
-examples/repoitems.py
-examples/builddefs.py
-examples/creattach.py
-examples/get_attachments.py
-examples/add_tcrs.py
+include LICENSE README.short README.rst setup.py
+include template.cfg rallyfire.py
+recursive-include pyral *.py
+recursive-include doc *.txt *.html *.js *.css *.png *.gif
+recursive-include examples *.py
+

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

README.rst

@@ -39,7 +39,9 @@ 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.0) has been tested using requests 2.8.1.
+The most recent release of pyral (1.2.1) has been tested using requests 2.8.1.
+
+Obtain and install the six_ module (available from PyPI at https://pypi.python.org/pypi/six)
 
 
 Unpack the ``pyral`` distribution file (zip or tar.gz) and then install the pyral_ package. 
@@ -61,11 +63,11 @@ relevant packages.
 :: 
 
    $ python
-   Python 2.7.11 [other Python interpreter info elided ...]
+   Python 3.5.1 [other Python interpreter info elided ...]
    >> import requests
    >> import pyral
    >> pyral.__version__
-   (1, 2, 0)
+   (1, 2, 1)
 
 
 
@@ -105,7 +107,7 @@ Common setup code ::
   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, apikey, workspace, project = rallyWorkset(options)
-  rally = Rally(server, user, password, workspace=workspace, project=project)
+  rally = Rally(server, user, password, apikey=apikey, workspace=workspace, project=project)
   rally.enableLogging('mypyral.log')
 
 Show a TestCase identified by the **FormattedID** value.
@@ -253,6 +255,7 @@ The item names in config files **are** case sensitive.
   --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
+  --ping                                boolean, ping Rally server before connection attempt?
 ====================================== =========================================
 
 
@@ -263,16 +266,24 @@ Prerequisites
  * Python 3.5 (this package not tested with earlier versions of Python 3.x)
  * The requests_ package, 2.0.0 or better (2.0.0 finally includes support for https proxy),
    requests 2.8.1 is recommended.
+ * The six_ package.
 
 .. _requests: http://github.com/kennethreitz/requests
+.. _six: https://bitbucket/gutworth/six
 
 Versions
 --------
 
-   1.2.0
+   **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.
+       Corrected handling of allowedValues for attributes when the single allowedValue is a boolean value.
+       Added an allowedValues.py example script.
+
+   **1.2.0**
        Support for Python 3.5.x
        Begin deprecation sequence for pinging the Rally server before the connection attempt, 
-             initially with this version, allow option on instantiation to bypass ping.
+       initially with this version, allow option on instantiation to bypass ping.
        Added ability to rankAbove, rankBelow, rankToTop, rankToBottom for an Artifact.
        Fixed defect where user has no default workspace or project.
 
@@ -286,7 +297,7 @@ Versions
    1.1.1 
        Modified entity.py to allow it to pass back PortfolioItem sub type instances.
        Modified rallyresp.py defect referencing non-existing req_type instance var by changing 
-                reference to request_type. 
+       reference to request_type. 
        Modified restapi.py to use user, dropped auth_user.
        Modified restapi.py to be more defensive when user has no associated UserProfile.
        Modified context.py to account for use of Cygwin in Pinger code.
@@ -296,7 +307,7 @@ Versions
        Modified restapi.py/entity.py to provide rudimentary support for querying of RecycleBin entries.
        Modified restapi.py and added search_utils.py to provide a search method for pyral Rally instances.
        Modified rallyresp.py to better handle some boundary conditions when response body item counts 
-                differ from what is stated in the TotalResultCount.
+       differ from what is stated in the TotalResultCount.
        Modified context.py to account for scenario where user's default workspace has no projects.
        Modified restapi.py/getProject to return correct project.
 

README.short

@@ -20,13 +20,14 @@ 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.0) has been tested with requests 2.8.1.
+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 has been installed, run the setup.py program supplied with 
+Once requests and six has been installed, run the setup.py program supplied with
 this distribution as::
 
     python setup.py install

build_dist.py

@@ -9,11 +9,13 @@
 import sys, os
 import tarfile
 import zipfile
+import re
 
 PACKAGE_NAME = "pyral"
-VERSION      = "1.2.0"
+VERSION      = "1.2.1"
 
 AUX_FILES  = ['MANIFEST.in', 
+              'PKG-INFO', 
               'LICENSE', 
               'README.short', 
               'README.rst', 
@@ -30,14 +32,16 @@
               'repoitems.py',
               'get_schema.py',
               'typedef.py',
+              'allowedValues.py', 
               'wkspcounts.py',
               'builddefs.py',
               'creattach.py',
               'get_attachments.py',
               'get_schedulable_artifacts.py',
               'add_tcrs.py',
               'defrevs.py',
-              'updtag.py'
+              'updtag.py',
+              'addtags.py'
              ]
 DOC_FILES  = ['doc/Makefile',
               'doc/source/conf.py',
@@ -75,6 +79,11 @@
 ################################################################################
 
 def main(args):
+    pkgcfg = package_meta('setup.py')
+    #peek_in_to_pkg(pkgcfg)
+    pkg_info = pkg_info_content(pkgcfg)
+    pifi = save_pkg_info(".", 'PKG-INFO', pkg_info)
+
     tarball = make_tarball(PACKAGE_NAME, VERSION, AUX_FILES, EXAMPLES, DOC_FILES)
     print tarball
 
@@ -93,6 +102,74 @@ def main(args):
 
 ################################################################################
 
+def package_meta(filename):
+    import imp
+
+    if not os.path.exists(filename):
+        raise Exception('No such file: %s' % filename)
+    with open(filename, 'r') as pcf:
+        content = pcf.read()
+    chunk, setup = re.split('setup\(', content, maxsplit=1, flags=re.M)
+    consties = [line for line in chunk.split("\n") 
+                      if (len(line) > 0 and line[0] == " ") or re.search(r'^[A-Z]', line)]
+    assignments = "\n".join(consties)
+
+    #print(assignments)
+    pkgcfg = imp.new_module('pkgcfg')
+    exec(assignments, pkgcfg.__dict__)
+    sys.modules['pkgcfg'] = pkgcfg
+    return pkgcfg
+
+################################################################################
+
+def indentified_text(source_body):
+    """
+        The source_body should be a single string with embedded newline chars.
+        This function splits the string on the newline chars, yielding a list
+        of strings.  The indentation should only be performed lines after the first
+        line.  The first line shall have no indentation performed.
+        Return the result as a single string.
+    """
+    lines = source_body.split("\n")
+    indented = ['        %s' % line for ix, line in enumerate(lines) if ix > 0]
+    indented.insert(0, lines[0])    
+    return "\n".join(indented)
+
+
+def pkg_info_content(pkgcfg):
+    with open(pkgcfg.SHORT_DESCRIPTION, 'r') as sdf: 
+        short_desc = indentified_text(sdf.read())
+    meta_ver    =   'Metadata-Version: 1.1'
+    name        =   'Name: %s'       % pkgcfg.PACKAGE
+    version     =   'Version: %s'    % pkgcfg.VERSION 
+    summary     =   'Summary: %s'    % pkgcfg.OFFICIAL_NAME
+    homepage    =   'Home-page: %s'  % pkgcfg.GITHUB_SITE
+    author      =   'Author: %s'     % pkgcfg.AUTHOR
+    license     =   'License: %s'    % pkgcfg.LICENSE
+    download    =   'Download-URL: %s' % pkgcfg.DOWNLOADABLE_ZIP
+    desc        =   'Description: %s'  % short_desc
+    keywords    =   'Keywords: %s'   % ",".join(pkgcfg.KEYWORDS)
+    requires    =  ['Requires: %s'   % reqmt for reqmt in pkgcfg.REQUIRES]
+    platform    =   'Platform: %s'   % pkgcfg.PLATFORM
+    classifiers =  ['Classifier: %s' % item for item in pkgcfg.CLASSIFIERS]
+
+    pki_items = [meta_ver, name, version, summary, homepage, author, license,
+                 download, desc, keywords, 
+                 "\n".join(requires), platform, "\n".join(classifiers)
+                ]
+    pkg_info = "\n".join(pki_items)
+    return pkg_info
+    
+
+def save_pkg_info(directory, filename, pkg_info):
+    full_path = os.path.join(directory, filename)
+    with open(full_path, 'w') as pif:
+        pif.write(pkg_info)
+        pif.write("\n")
+    return full_path
+
+################################################################################
+
 def make_tarball(pkg_name, pkg_version, base_files, example_files, doc_files):
 
     base_dir = '%s-%s' % (pkg_name, pkg_version)
@@ -146,7 +223,6 @@ def make_zipfile(pkg_name, pkg_version, base_files, example_files, doc_files):
         elif os.path.isdir(doc_item):
             sub_items = os.listdir(doc_item)
             for sub_item in sub_items:
-                
                 zf.write('%s/%s' % (doc_item, sub_item), '%s/%s/%s' % (base_dir, doc_item, sub_item), zipfile.ZIP_DEFLATED)
 
     zf.close()