@@ -2,7 +2,7 @@ pyral - A Python toolkit for the Rally REST API
22===============================================
33
44
5- The `pyral <http://github.com/Rallydev/pyral >`_ package enables you to push, pull
5+ The `pyral <http://github.com/RallyTools/RallyRestToolkitForPython >`_ package enables you to push, pull
66and otherwise wrangle the data in your Rally subscription using the popular
77and productive Python language.
88The ``pyral `` package provides a smooth and easy to use veneer on top
@@ -24,7 +24,7 @@ Files are available at the `download page`_ .
2424
2525.. _download page : http://pypi.python.org/pypi/pyral
2626
27- The git repository is available at http ://github.com/Rallydev/pyral
27+ The git repository is available at https ://github.com/RallyTools/RallyRestToolkitForPython
2828
2929
3030Installation
@@ -59,7 +59,7 @@ relevant packages.
5959 >> import requests
6060 >> import pyral
6161 >> pyral.__version__
62- (0, 9, 4 )
62+ (1, 0, 0 )
6363
6464
6565
@@ -228,7 +228,6 @@ create an instance of the Rally class.
228228 PASSWORD password for the Rally subscription UserName
229229 WORKSPACE Rally Workspace
230230 PROJECT Rally Project
231- VERSION Rally REST Web Services API version
232231====================================== =========================================
233232
234233The item names in config files **are ** case sensitive.
@@ -246,25 +245,28 @@ The item names in config files **are** case sensitive.
246245 --rallyPassword=<bar> password associated with the Rally UserName
247246 --rallyWorkspace=<bar> Workspace in Rally you want to interact with
248247 --rallyProject=<bar> Project in Rally you want to interact with
249- --rallyVersion=<bar> Rally REST Web Services API version
250248====================================== =========================================
251249
252250
253251Prerequisites
254252-------------
255253
256- * Python 2.6 or 2.7
257- * The requests _ package, 0.9.3 or better
258- Recommend using requests 2.0.0 or better. 2.0.0 finally includes support for https proxy.
259- Developed using requests 0.9.3.
260- There are reports where requests > 0.9.3 resulted in connection problems (as in not being able to connect) that may be related to SSL. You should be able to use the verify_ssl_cert keyword argument when
261- obtaining a pyral Rally instance to overcome this issue.
262- If you are using requests < 1.0.0, you must also have certifi-0.0.8 (available on PyPI)
254+ * Python 2.6 or 2.7 (2.7 is preferred)
255+ * The requests _ package, 2.0.0 or better (2.0.0 finally includes support for https proxy)
263256
264257.. _requests : http://github.com/kennethreitz/requests
265258
266259Versions
267260--------
261+
262+ * 1.0.0 -
263+ Default WSAPI version in config is v2.0. This version is not compatible
264+ with Rally WSAPI version 1.x.
265+ Adjusted the RallyUrlBuilder (via RallyQueryFormatter) to be more resilient
266+ with respect to many more "special" characters (non-alphanumeric).
267+ Retrieving the meta data uses the v2.0 schema endpoint.
268+ No longer support a version keyword argument when obtaining a Rally instance.
269+
268270 * 0.9.4 -
269271 Adjusted Rally __init__ to accommodate using requests 0.x, 1.x, 2.x versions.
270272 Factored out query building and fixed constructing multi condition queries.
@@ -323,22 +325,15 @@ Versions
323325
324326TODO
325327----
326- * Python 3.3 + support
327-
328- * Support Rally WSAPI 2.0
329-
330- * Expand the documentation
331-
332- * Expand the repertoire of example scripts
328+ * Python 3.3+ support
333329
334- * Refactor the source code to make use decorators in pyral.restapi,
335- dynamically construct the Rally schema hierarchy economically.
330+ * Dynamically construct the Rally schema hierarchy economically.
336331
337332
338333License
339334-------
340335
341- BSD3-style license. Copyright (c) 2010-2013 Rally Software Development.
336+ BSD3-style license. Copyright (c) 2010-2014 Rally Software Development.
342337
343338See the LICENSE file provided with the source distribution for full details.
344339
0 commit comments