{"id":17209227,"url":"https://github.com/dixudx/rtcclient","last_synced_at":"2025-04-04T15:08:13.948Z","repository":{"id":34991633,"uuid":"39077888","full_name":"dixudx/rtcclient","owner":"dixudx","description":"RTCClient for Rational Team Concert","archived":false,"fork":false,"pushed_at":"2025-03-06T03:49:28.000Z","size":440,"stargazers_count":38,"open_issues_count":48,"forks_count":45,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-28T14:08:19.755Z","etag":null,"topics":["python","python-library","rational-team-concert","rtc"],"latest_commit_sha":null,"homepage":"https://readthedocs.org/projects/rtcclient/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dixudx.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-07-14T13:57:55.000Z","updated_at":"2024-11-04T15:38:01.000Z","dependencies_parsed_at":"2024-01-12T07:03:27.254Z","dependency_job_id":"9491f69d-78cf-4b45-ba84-569e0a894a1c","html_url":"https://github.com/dixudx/rtcclient","commit_stats":{"total_commits":252,"total_committers":7,"mean_commits":36.0,"dds":0.07936507936507942,"last_synced_commit":"b35deed7660a5d52eaaa245ea87a9883bc353d08"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dixudx%2Frtcclient","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dixudx%2Frtcclient/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dixudx%2Frtcclient/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dixudx%2Frtcclient/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dixudx","download_url":"https://codeload.github.com/dixudx/rtcclient/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247198459,"owners_count":20900080,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["python","python-library","rational-team-concert","rtc"],"created_at":"2024-10-15T02:51:05.231Z","updated_at":"2025-04-04T15:08:13.928Z","avatar_url":"https://github.com/dixudx.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"rtcclient\n=========\n\n.. image:: https://readthedocs.org/projects/rtcclient/badge/?version=latest\n    :target: https://readthedocs.org/projects/rtcclient\n\n.. image:: https://img.shields.io/pypi/v/rtcclient.svg\n    :target: https://pypi.python.org/pypi/rtcclient\n\n.. image:: https://github.com/dixudx/rtcclient/actions/workflows/ci.yml/badge.svg\n    :target: https://github.com/dixudx/rtcclient\n\n.. image:: https://img.shields.io/badge/slack-rtcclient-blue.svg\n    :target: https://rtcclient.slack.com\n\n.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg\n    :target: https://saythanks.io/to/dixudx\n\nA Python-based Client/API for Rational Team Concert (RTC)\n\nAbout this library\n------------------\n\nIBM® Rational Team Concert™, is built on the Jazz platform, allowing\napplication development teams to use one tool to plan across teams, code,\nrun standups, plan sprints, and track work. For more info, please refer\nto here_.\n\n.. _here: http://www.ibm.com/developerworks/downloads/r/rtc/\n\n**IMPORTANT NOTE: This is NOT an official-released Python-based RTC Client.**\n\nThis library can help you:\n\n* Interacts with an RTC server to retrieve objects which contain the detailed information/configuration, including **Project Areas**, **Team Areas**, **Workitems** and etc;\n* Creates all kinds of **Workitems** through self-customized templates or copies from some existing **Workitems**;\n* Performs some actions on the retrieved **Workitems**, including get/add **Comments**, get/add/remove **Subscribers**/**Children**/**Parent**, get/upload **Attachments** and etc;\n* Query **Workitems** using specified filtered rules or directly from your saved queries;\n* Logs all the activities and messages during your operation;\n\n\nPython \u0026 Rational Team Concert Versions\n---------------------------------------\n\nThis project has been tested against multiple Python versions, such as \"3.7\", \"3.8\", \"3.9\", \"3.10\" and \"3.11\".\n\nPlease install **rtcclient** with version **\u003e= 0.9.0**, which works well with ``Rational Team Concert`` **6.0.6.1**, **5.0.1**, **5.0.2** and ``ELM`` **7.0**.\n\nImportant Links\n---------------\n\nSupport and bug-reports:\nhttps://github.com/dixudx/rtcclient/issues?q=is%3Aopen+sort%3Acomments-desc\n\nProject source code: https://github.com/dixudx/rtcclient\n\nProject documentation: https://readthedocs.org/projects/rtcclient/\n\n\nInstallation\n------------\n\nTo install rtcclient, simply:\n\n.. code-block:: bash\n\n    $ pip install rtcclient\n\n\nExample\n-------\n\nRTCClient is intended to map the objects in RTC (e.g. Project Areas,\nTeam Areas, Workitems) into easily managed Python objects:\n\n.. code-block:: python\n\n    \u003e\u003e\u003e from rtcclient.utils import setup_basic_logging\n    \u003e\u003e\u003e from rtcclient import RTCClient\n    # you can remove this if you don't need logging\n    # default debug logging for console output\n    \u003e\u003e\u003e setup_basic_logging()\n    # url ends with jazz\n    \u003e\u003e\u003e url = \"https://your_domain:9443/jazz\"\n    \u003e\u003e\u003e username = \"your_username\"\n    \u003e\u003e\u003e password = \"your_password\"\n    # If your rtc server is behind a proxy, remember to set \"proxies\" explicitly.\n    # If your url ends with ccm, set ends_with_jazz to False.\n    # Please refer to issue #68 for detailed explanation\n    # If your rtc server is too old (such as Rational Team Concert 5.0.1, 5.0.2), please set old_rtc_authentication to True\n    \u003e\u003e\u003e myclient = RTCClient(url, username, password, ends_with_jazz=True, old_rtc_authentication=False)\n    # it will be faster if returned properties is specified\n    # see in below query example\n    \u003e\u003e\u003e wk = myclient.getWorkitem(123456) # get a workitem whose id is 123456\n    # get all workitems\n    # If both projectarea_id and projectarea_name are None, all the workitems\n    # in all ProjectAreas will be returned\n    \u003e\u003e\u003e workitems_list = myclient.getWorkitems(projectarea_id=None,\n                                               projectarea_name=None)\n    \u003e\u003e\u003e myquery = myclient.query # query class\n    \u003e\u003e\u003e projectarea_name = \"your_projectarea_name\"\n    # customize your query string\n    # below query string means: query all the workitems with title \"use case 1\"\n    \u003e\u003e\u003e myquerystr = 'dc:title=\"use case 1\"'\n    # specify the returned properties: title, id, state, owner\n    # This is optional. All properties will be returned if not specified\n    \u003e\u003e\u003e returned_prop = \"dc:title,dc:identifier,rtc_cm:state,rtc_cm:ownedBy\"\n    \u003e\u003e\u003e queried_wis = myquery.queryWorkitems(query_str=myquerystr,\n                                             projectarea_name=projectarea_name,\n                                             returned_properties=returned_prop)\n\n\nTesting\n-------\n\nUsing a virtualenv is recommended. Setuptools will automatically fetch\nmissing test dependencies.\n\nIf you have installed the tox_ on your system already, you can run\nthe tests using pytest_ with the following command:\n\n.. _tox: https://pypi.python.org/pypi/tox\n.. _pytest: http://pytest.org/latest/\n\n.. code-block:: bash\n\n    virtualenv\n    source .venv/bin/active\n    (venv) tox -e test\n    (venv) tox -e flake\n    (venv) tox -e pycodestyle\n\n\nTesting with Poetry\n-------------------\n\nWhen using poetry_ , all dependencies and test environment are managed by this tool even when using tox_.\n\nIf you have already globally installed poetry_ on your system, you can run\nthe tests using pytest_ with the following command:\n\n.. _poetry: https://python-poetry.org/\n\n.. code-block:: bash\n\n    poetry install --with devel\n    poetry run tox -e test\n    poetry run tox -e flake\n    poetry run tox -e pycodestyle\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdixudx%2Frtcclient","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdixudx%2Frtcclient","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdixudx%2Frtcclient/lists"}