Metadata-Version: 2.0
Name: rtcclient
Version: 0.3.0
Summary: RTCClient for Rational Team Concert
Home-page: https://github.com/dixudx/rtcclient
Author: Di Xu
Author-email: stephenhsu90@gmail.com
License: Apache License, Version 2.0
Keywords: rtcclient
Requires-Dist: xmltodict
Requires-Dist: requests
Requires-Dist: jinja2 (>=2.2)
Requires-Dist: six

rtcclient
=========

.. image:: https://readthedocs.org/projects/rtcclient/badge/?version=latest
    :target: https://readthedocs.org/projects/rtcclient

.. image:: https://img.shields.io/pypi/v/rtcclient.svg
    :target: https://pypi.python.org/pypi/rtcclient

.. image:: https://img.shields.io/pypi/dm/rtcclient.svg
    :target: https://pypi.python.org/pypi/rtcclient

A Python-based Client/API for Rational Team Concert (RTC)

About this library
------------------

IBM® Rational Team Concert™, is built on the Jazz platform, allowing
application development teams to use one tool to plan across teams, code,
run standups, plan sprints, and track work. For more info, please refer
to here_.

.. _here: http://www.ibm.com/developerworks/downloads/r/rtc/

**IMPORTANT NOTE: THIS IS NOT AN OFFICIAL Python-based RTC Client.**

This library can help you:

* Interacts with an RTC server to retrieve objects which contain the detailed information/configuration, including Project Areas, Team Areas, Workitems, Saved Queries, etc
* Creates all kinds of Workitems through self-customized templates or Copies from some existing Workitems
* Add comments to the retrieved Workitems
* Add/remove subscribers to/from the retrieved Workitems
* Query Workitems using specified filtered rules or directly from your saved queries
* Logs all the activities and messages during your operation


Python & Rational Team Concert versions
---------------------------------------

The project have been tested against ``Rational Team Concert`` **5.0.1** and
**5.0.2** on Python 2.6, 2.7 and 3.3.


Important Links
---------------

Support and bug-reports:
https://github.com/dixudx/rtcclient/issues?q=is%3Aopen+sort%3Acomments-desc

Project source code: https://github.com/dixudx/rtcclient

Project documentation: https://readthedocs.org/projects/rtcclient/


Installation
------------

To install rtcclient, simply:

.. code-block:: bash

    $ pip install rtcclient


Example
-------

RTCClient is intended to map the objects in RTC (e.g. Project Areas,
Team Areas, Workitems) into easily managed Python objects:

.. code-block:: python

    >>> from rtcclient.utils import setup_basic_logging
    >>> from rtcclient.client import RTCClient
    # you can remove this if you don't need logging
    # default logging for console output
    >>> setup_basic_logging()
    >>> url = "https://your_domain:9443/jazz"
    >>> username = "your_username"
    >>> password = "your_password"
    >>> myclient = RTCClient(url, username, password)
    # it will be faster if returned properties is specified
    # see in below query example
    >>> wk = myclient.getWorkitem(123456) # get a workitem whose id is 123456
    # get all workitems
    # If both projectarea_id and projectarea_name are None, all the workitems
    # in all ProjectAreas will be returned
    >>> workitems_list = myclient.getWorkitems(projectarea_id=None,
                                               projectarea_name=None)
    >>> myquery = myclient.query # query class
    >>> projectarea_name = "your_projectarea_name"
    # customize your query string
    # below query string means: query all the workitems with title "use case 1"
    >>> myquerystr = 'dc:title="use case 1"'
    # specify the returned properties: title, id, state, owner
    # This is optional. All properties will be returned if not specified
    >>> returned_prop = "dc:title,dc:identifier,rtc_cm:state,rtc_cm:ownedBy"
    >>> queried_wis = myquery.queryWorkitems(query_str=myquerystr,
                                             projectarea_name=projectarea_name,
                                             returned_properties=returned_prop)


Testing
-------

Using a virtualenv is recommended. Setuptools will automatically fetch
missing test dependencies.

If you have installed the tox_ on your system already, you can run
the tests using pytest_ with the following command:

.. _tox: https://pypi.python.org/pypi/tox
.. _pytest: http://pytest.org/latest/

.. code-block:: bash

    virtualenv
    source .venv/bin/active
    (venv) tox -e py27
    (venv) tox -e py33
    (venv) tox -e pep8



