multithreading support, new default pagesize of 500, fixed getAllUsers

klehman-rally · klehman-rally · commit 9c40e67f2108 · 2017-03-31T11:19:29.000-06:00
diff --git a/MANIFEST b/MANIFEST
@@ -7,6 +7,7 @@ rallyfire.py
 pyral/__init__.py
 pyral/config.py
 pyral/context.py
+pyral/cargotruck.py
 pyral/entity.py
 pyral/hydrate.py
 pyral/rallyresp.py
diff --git a/README.rst b/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.4) has been tested using requests 2.8.1.
+The most recent release of pyral (1.3.0) 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, 4)
+   (1, 3, 0)
 
 
 
@@ -265,14 +265,21 @@ Prerequisites
  * Python 3.5 (this package not tested with earlier versions of Python 3.x) OR
  * 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),
-   requests 2.8.1 is recommended.
+   requests 2.12.5 is recommended.
  * The six_ package.
 
 .. _requests: http://github.com/kennethreitz/requests
 .. _six: https://bitbucket.org/gutworth/six
 
 Versions
 --------
+   **1.3.0**
+       Introduced automatic multi-threading for Rally.get operation to speed up retrieval of large
+       result sets.  Implemented step two of the Pinger deprecation plan, ping=False is the new default.
+       Increased default page size to 500.  Maximum useful page size limit is 2000 but 1000 seems
+       to be the sweet spot for multithreading requests.
+       Fixed Rally.getAllUsers so that non subscription admin accounts can see the user list.
+       Updated recommendation for version of requests package.
 
    **1.2.4**
        Fixed handling of projectScopeUp and projectScopeDown keyword arguments for get operation.
diff --git a/README.short b/README.short
@@ -20,7 +20,7 @@ Requirements
 The pyral package requires the use of Kenneth Reitz's requests package using version 2.8.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.4) has been tested with requests 2.8.1.
+The most recent release of pyral (1.3.0) has been tested with requests 2.12.5.
 The six module is also required.
 
 
diff --git a/build_dist.py b/build_dist.py
@@ -13,7 +13,7 @@
 import re
 
 PACKAGE_NAME = "pyral"
-VERSION      = "1.2.4"
+VERSION      = "1.3.0"
 
 AUX_FILES  = ['MANIFEST.in', 
               'PKG-INFO', 
@@ -104,7 +104,7 @@ def main(args):
 
     # 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
+    wheel_file = "%s-%s-py2.py3-none-any.whl" % (PACKAGE_NAME, VERSION)
     # the wheel_file gets written into the dist  subdir by default, no need for a copy...
 
     store_packages('dist',  [tarball])
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -48,9 +48,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.2.4'
+version = '1.3.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.2.4'
+release = '1.3.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/doc/source/interface.rst b/doc/source/interface.rst
@@ -131,7 +131,7 @@ Example use::
     print " ".join(['|%|' % opt for opt in [server, user, password, apikey, workspace, project]]
 
 
-    % python basic.py --config=current --rallyProject="Livestock Mgmt" --ping=no
+    % python basic.py --config=current --rallyProject="Livestock Mgmt" --ping=yes
 
     |rally1.rallydev.com| |wiley@acme.com| |*****| |*****| |General Products Umbrella| |Livestock Mgmt|
 
@@ -289,16 +289,14 @@ To instantiate a Rally object, you'll need to provide these arguments:
                     and the default project for the user is not in the workspace specified.  
                     Under those conditions, the project is changed to the first project
                     (alphabetic ordering) in the list of projects for the specified workspace.
-        * server_ping     (True or False, default in v1.2.0 is True)
+        * server_ping     (True or False, default in v1.3.0 is False)
                    Specifies whether a ping attempt will be made to confirm network connectivity
                    to the Rally server prior to making a Rally WSAPI REST request.
                    Organizations may have disabled the ability to make ICMP requests so the ping
                    attempt may fail even though there is network connectivity to the Rally server.
                    For this reason, the use of the ping=True option is discouraged going forward.
-                   The next minor point release of pyral (v1.3.0) will have the default value 
-                   for this option inverted to be False.  
                    The the ping operation itself will be dropped in the next major release (2.0.0).
-        * isolated_workspace  (True or False, default in v1.2.0 is False)
+        * isolated_workspace  (True or False, default in v1.2.0 + is False)
                    Specifies that the Rally instance will only be used for interacting with 
                    a single workspace (either the user's default workspace or the named workspace).
                    Using isolated_workspace=True provides performance benefits for a subscription
@@ -330,7 +328,7 @@ To instantiate a Rally object, you'll need to provide these arguments:
         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)
+.. py:class:: Rally (server, user=None, password=None, apikey=None, workspace=None, project=None, warn=True, server_ping=False)
 
 Examples::
 
diff --git a/pyral/__init__.py b/pyral/__init__.py
@@ -1,4 +1,4 @@
-__version__ = (1, 2, 4)
+__version__ = (1, 3, 0)
 from .config    import rallySettings, rallyWorkset
 from .restapi   import Rally, RallyRESTAPIError, RallyUrlBuilder
 from .rallyresp import RallyRESTResponse
diff --git a/pyral/config.py b/pyral/config.py
@@ -6,7 +6,7 @@
 #
 ###################################################################################################
 
-__version__ = (1, 2, 4)
+__version__ = (1, 3, 0)
 
 import datetime
 import os
@@ -27,7 +27,7 @@
 PASSWORD  = "G3ronim0!"
 
 START_INDEX  =   1
-MAX_PAGESIZE = 200
+MAX_PAGESIZE = 500
 MAX_ITEMS    = 1000000  # a million seems an eminently reasonable limit ...
 
 RALLY_REST_HEADERS = \
diff --git a/pyral/context.py b/pyral/context.py
@@ -8,7 +8,7 @@
 #
 ###################################################################################################
 
-__version__ = (1, 2, 4)
+__version__ = (1, 3, 0)
 
 import sys, os
 import platform
@@ -26,7 +26,7 @@
 
 ###################################################################################################
 
-__all__ = ["RallyContext", "RallyContextHelper"]
+__all__ = ["RallyContext", "RallyContextHelper", "AgileCentralContext", "AgileCentralContextHelper"]
 
 ###################################################################################################
 
@@ -87,6 +87,8 @@ def identity(self):
 
     def __repr__(self):
         return self.identity()
+
+AgileCentralContext = RallyContext
         
 ##################################################################################################
 
@@ -911,6 +913,8 @@ def __repr__(self):
         representation = "\n".join(items)
         return representation
 
+AgileCentralContextHelper = RallyContextHelper 
+
 ##################################################################################################
 
 class Pinger(object):
diff --git a/pyral/entity.py b/pyral/entity.py
@@ -8,7 +8,7 @@
 #
 ###################################################################################################
 
-__version__ = (1, 2, 4)
+__version__ = (1, 3, 0)
 
 import sys
 import re
diff --git a/pyral/hydrate.py b/pyral/hydrate.py
@@ -9,7 +9,7 @@
 #
 ###################################################################################################
 
-__version__ = (1, 2, 4)
+__version__ = (1, 3, 0)
 
 import sys
 import imp
diff --git a/pyral/query_builder.py b/pyral/query_builder.py
@@ -6,7 +6,7 @@
 #
 ###################################################################################################
 
-__version__ = (1, 2, 4)
+__version__ = (1, 3, 0)
 
 import re
 import types
diff --git a/pyral/rallyresp.py b/pyral/rallyresp.py
diff --git a/pyral/restapi.py b/pyral/restapi.py
diff --git a/pyral/search_utils.py b/pyral/search_utils.py
diff --git a/setup.py b/setup.py
diff --git a/test/test_big_query.py b/test/test_big_query.py
diff --git a/upver.py b/upver.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-__version__ = (1, 2, 4)`
	`1`	`+__version__ = (1, 3, 0)`
`2`	`2`	`from .config import rallySettings, rallyWorkset`
`3`	`3`	`from .restapi import Rally, RallyRESTAPIError, RallyUrlBuilder`
`4`	`4`	`from .rallyresp import RallyRESTResponse`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`#`
`9`	`9`	`###################################################################################################`
`10`	`10`
`11`		`-__version__ = (1, 2, 4)`
	`11`	`+__version__ = (1, 3, 0)`
`12`	`12`
`13`	`13`	`import sys`
`14`	`14`	`import re`