gross match to klehman-rally/pyral 1.6.0 master

Author: klehman-rally

.gitignore

@@ -0,0 +1,65 @@
+
+Addendum.txt
+
+yeti*.cfg
+
+.pypirc
+.*.swp
+
+.DS_Store
+.idea/
+venv/
+pyral/__pycache__/
+
+*.pyc
+test/rally_targets.py
+test/rally_targets-real.py
+test/rally_targets-safe.py
+test/raltargs.py
+test/.*.swp
+*.tar
+do_cover
+do_qt
+
+collection-attrs
+dev-notes-for-1.2.0
+*1.2.*
+doc/build/html/pyral-docs.html.zip
+entity-new.py
+get*.py
+huuque.py
+examples/stryftr.py
+rally.cfg
+kip.cfg
+coll.cfg
+nick.cfg
+yodel.cfg
+examples/rally.cfg
+examples/yeti.cfg
+*.log
+holding-tank/
+temp/
+.cache
+rally-v2.0.cfg
+nmds.cfg
+notes-1.0.1
+notes-1.1.0
+notes-1.1.1
+query_condition_value_has_matched_internal_parens
+spec_char_query
+style.sins
+test/query_condition_value_has_matched_internal_parens
+test/wksp_proj_matrix.notes
+v2.notes*
+threading-performance.data
+codestyle.setup.cfg
+.coverage*
+cov_html/
+release-guide-*
+pyral-*.tar.gz
+pyral-*.zip
+dist/lab/
+dists/pyral-*.tgz
+dist/sdist-generated
+build/
+pkin.py

LICENSE

@@ -1,4 +1,4 @@
-Copyright © Broadcom, Inc. - 2018-2021; CA Technoligies - 2015-2018;  Rally Software Development Corp. - 2010-2015
+Copyright © Broadcom, Inc. - 2018-2024; CA Technologies - 2015-2018;  Rally Software Development Corp. - 2010-2015
 All rights reserved.
 
 License for pyral (a Python toolkit for the Rally REST API)

PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 1.1
 Name: pyral
-Version: 1.5.2
+Version: 1.6.0
 Summary: Python toolkit for Rally REST API
 Home-page: https://github.com/RallyTools/RallyRestToolkitForPython
-Author: Kip Lehman (Broadcom, Enterprise Software Division)
+Author: Kip Lehman (Broadcom, Agile Operations Division)
 License: BSD
-Download-URL: https://github.com/RallyTools/RallyRestToolkitForPython/raw/master/dists/pyral-1.5.2.zip
+Download-URL: https://github.com/RallyTools/RallyRestToolkitForPython/raw/master/dists/pyral-1.6.0.zip
 Description: This is the README file for pyral, a package implementing a 
         Pythonic interface to the Rally REST API
 
@@ -25,11 +25,9 @@ Description: This is the README file for pyral, a package implementing a
         Requirements
         ------------
 
-        The pyral package requires the use of Kenneth Reitz's requests package using version 2.12.0 or better.
-        As of requests version 2.0.0, there is support for HTTPS over HTTP proxy via the CONNECT request.
+        The pyral package requires the use of Kenneth Reitz's requests package using version 2.28.0 or better.
         The requests package can be found via the Python Package Index site (http://pypi/python.org/index).
-        The most recent release of pyral (1.5.2) has been tested with requests 2.22.0.
-        The six module is also required.
+        The most recent release of pyral (1.6.0) has been tested with requests 2.31.0.
 
 
         Installation
@@ -42,9 +40,8 @@ Description: This is the README file for pyral, a package implementing a
             pip install pyral
 
         Alternatively if you've got the tar.gz or zip distribution on hand, as long as you've
-        satisfied the dependency requirements on the six and requests packages, you can use
-        the setup mechanism.
-        Once requests and six has been installed, run the setup.py program supplied with
+        satisfied the dependency requirement of the requests packages, you can use the setup mechanism.
+        Once the requests package has been installed, run the setup.py program supplied with
         this distribution as::
 
             python setup.py install
@@ -72,18 +69,17 @@ Description: This is the README file for pyral, a package implementing a
 
 
 Keywords: rally,api
-Requires: six
-Requires: requests>=2.25.1
+Requires: requests>=2.28.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 :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries

README.rst

@@ -7,10 +7,6 @@ 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 JSON.
 
-This package is once again branded as a 'Rally' toolkit.
-The era of "Agile Central" branding is over, we'll not speak of it again.
-
-
 .. contents::
 
 Getting started
@@ -40,18 +36,13 @@ pip, the Python package installation utility.::
     pip install pyral
 
 Alternatively, if you've got the tar.gz or zip distribution on hand, as long as you've
-satisfied the dependency requirements on the six and requests packages, you can use
-the setup mechanism.
+satisfied the dependency requirement on the requests package, you can use the setup mechanism.
 Obtain the requests_ package and install it according to that package's directions.
-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.
+Use of requests-2.28.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.5.2) has been tested using requests 2.22.0.
-
-Obtain and install the six_ module (available from PyPI at https://pypi.python.org/pypi/six)
+The most recent release of pyral (1.6.0) has been tested using requests 2.31.0.
 
-
-Unpack the ``pyral`` distribution file (zip or tar.gz) and then install the pyral_ package. 
+Unpack the ``pyral`` distribution file (zip or tar.gz) and then install the pyral_ package.
 
 :: 
 
@@ -70,12 +61,11 @@ relevant packages.
 :: 
 
    $ python
-   Python 3.8.5 [other Python interpreter info elided ...]
+   Python 3.11.5 [other Python interpreter info elided ...]
    >> import requests
    >> import pyral
    >> pyral.__version__
-   (1, 5, 2)
-
+   (1, 6, 0)
 
 
 30 second highlight
@@ -251,16 +241,20 @@ The item names in config files **are** case sensitive.
 Prerequisites
 -------------
 
- * Python 3.6, 3.7, 3.8 or 3.9 (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.22.0 or more recent is recommended.
- * The six_ package.
+ * Python 3.9, 3,10, 3.11 or 3.12 (this package not tested with earlier versions of Python 3.x)
+ * The requests_ package, 2.28.1 or better, requests 2.31.0 or beyond is recommended.
 
 .. _requests: http://github.com/kennethreitz/requests
-.. _six: https://bitbucket.org/gutworth/six
 
 Versions
 --------
+   **1.6.0**
+       Eliminated use of six package.
+       Added support for Risk, Objective, KeyResult and CapacityPlan* entities.
+       Fixed bug in restapi.getAllUsers that prevented retrieval of Users beyond the first chunk
+       Adjusted restapi.py treatment of headers to allow multiple pyral.Rally instances (could be various users...).
+       Explicitly state support for Python 3.9, 3.10, 3.11 and 3.12
+       Drop any mention of support for versions 3.8 and earlier.
 
    **1.5.2**
        Fixed query builder so that multi-condition queries thet include subset or range conditions 
@@ -365,7 +359,7 @@ TODO
 License
 -------
 
-BSD3-style license. Copyright (c) 2018-2021 Broadcom, Inc., 2015-2018 CA Technologies, 2010-2015 Rally Software Development.
+BSD3-style license. Copyright (c) 2018-2024 Broadcom, Inc., 2015-2018 CA Technologies, 2010-2015 Rally Software Development.
 
 See the LICENSE file provided with the source distribution for full details.
 

README.short

@@ -17,11 +17,9 @@ 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.12.0 or better.
-As of requests version 2.0.0, there is support for HTTPS over HTTP proxy via the CONNECT request.
+The pyral package requires the use of Kenneth Reitz's requests package using version 2.28.0 or better.
 The requests package can be found via the Python Package Index site (http://pypi/python.org/index).
-The most recent release of pyral (1.5.2) has been tested with requests 2.22.0.
-The six module is also required.
+The most recent release of pyral (1.6.0) has been tested with requests 2.31.0.
 
 
 Installation
@@ -34,9 +32,8 @@ pip, the Python package installation utility.::
     pip install pyral
 
 Alternatively if you've got the tar.gz or zip distribution on hand, as long as you've
-satisfied the dependency requirements on the six and requests packages, you can use
-the setup mechanism.
-Once requests and six has been installed, run the setup.py program supplied with
+satisfied the dependency requirement of the requests packages, you can use the setup mechanism.
+Once the requests package has been installed, run the setup.py program supplied with
 this distribution as::
 
     python setup.py install

VERSIONS

@@ -154,7 +154,11 @@
     Excised all mentions of AgileCentral in the docs, replaced by 'Rally'.
 
 1.5.2 - Jul 2021
-    Fixed query builder so that multi-condition queries thet include subset or range conditions 
+    Fixed query builder so that multi-condition queries that include subset or range conditions 
     are constructed correctly.
     Dropped all code related to ping functionality.
 
+1.6.0 - Feb 2024
+    Updated supported Python versions to 3.9, 3.10, 3.11 and 3.12. No longer requires six package.
+    Fixed defect in the getAllUsers method that prevented Users beyond the first page from being retrieved.
+

build_dist.py

@@ -14,7 +14,7 @@
 import re
 
 PACKAGE_NAME = "pyral"
-VERSION      = "1.5.2"
+VERSION      = "1.6.0"
 
 AUX_FILES  = ['MANIFEST.in', 
               'PKG-INFO', 
@@ -65,9 +65,9 @@
               'doc/build/html/_static',
               'doc/build/html/_static/css',
               'doc/build/html/_static/css/fonts',
-              'doc/build/html/_static/fonts',
-              'doc/build/html/_static/fonts/Lato',
-              'doc/build/html/_static/fonts/RobotoSlab',
+              #'doc/build/html/_static/fonts',
+              #'doc/build/html/_static/fonts/Lato',
+              #'doc/build/html/_static/fonts/RobotoSlab',
               'doc/build/html/_static/js',
              ]
 

cr_milestone.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python
+
+#################################################################################################
+#
+#  cr_milestone.py -- Create a Milestone instance with a Name and TargetDate
+#
+USAGE = """
+Usage: cr_milestone.py  <name> <target_date>
+"""
+#################################################################################################
+
+import sys, os
+from pyral import Rally, rallyWorkset
+
+#################################################################################################
+
+errout = sys.stderr.write
+
+#################################################################################################
+
+def main(args):
+    options = [opt for opt in args if opt.startswith('--')]
+    args    = [arg for arg in args if arg not in options]
+
+    if len(args) != 2:
+        print("No arguments for the Milestone Name or TargetDate were specified")
+        sys.exit(1)
+
+    server, user, password, apikey, workspace, project = rallyWorkset(options)
+    if apikey:
+        rally = Rally(server, apikey=apikey, workspace=workspace, project=project)
+    else:
+        rally = Rally(server, user=user, password=password, workspace=workspace, project=project)
+
+    target_project = rally.getProject()
+    target_entity_name    = 'Milestone'
+    milestone_name, milestone_target_date = args[:2]
+    info = { 'Name'       : milestone_name,
+             'TargetDate' : milestone_target_date
+           }
+
+
+    print(f"Creating {target_entity_name} ...")
+    milestone = rally.put(target_entity_name, info)
+    print(f"Created  Milestone: {milestone.FormattedID}   OID: {milestone.oid}  Name: {milestone.Name}  TargetDate: {milestone.TargetDate}")
+
+#################################################################################################
+#################################################################################################
+
+if __name__ == '__main__':
+    main(sys.argv[1:])