Package: rtcclient
A Python-based Client/API for Rational Team Concert (RTC)About this libraryIBM® 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
tohere.IMPORTANT NOTE: This is NOT an official-released Python-based RTC Client.This library can help you:Interacts with an RTC server to retrieve objects which contain the detailed information/configuration, includingProject Areas,Team Areas,Workitemsand etc;Creates all kinds ofWorkitemsthrough self-customized templates or copies from some existingWorkitems;Performs some actions on the retrievedWorkitems, including get/addComments, get/add/removeSubscribers/Children/Parent, get/uploadAttachmentsand etc;QueryWorkitemsusing specified filtered rules or directly from your saved queries;Logs all the activities and messages during your operation;Python & Rational Team Concert VersionsThis project has been tested against multiple Python versions, such as “3.7”, “3.8”, “3.9”, “3.10” and “3.11”.Please installrtcclientwith version >= 0.9.0, which works well withRational Team Concert6.0.6.1,5.0.1,5.0.2andELM7.0.Important LinksSupport and bug-reports:https://github.com/dixudx/rtcclient/issues?q=is%3Aopen+sort%3Acomments-descProject source code:https://github.com/dixudx/rtcclientProject documentation:https://readthedocs.org/projects/rtcclient/InstallationTo install rtcclient, simply:$pipinstallrtcclientExampleRTCClient is intended to map the objects in RTC (e.g. Project Areas,
Team Areas, Workitems) into easily managed Python objects:>>>fromrtcclient.utilsimportsetup_basic_logging>>>fromrtcclientimportRTCClient# you can remove this if you don't need logging# default debug logging for console output>>>setup_basic_logging()# url ends with jazz>>>url="https://your_domain:9443/jazz">>>username="your_username">>>password="your_password"# If your rtc server is behind a proxy, remember to set "proxies" explicitly.# If your url ends with ccm, set ends_with_jazz to False.# Please refer to issue #68 for detailed explanation# 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>>>myclient=RTCClient(url,username,password,ends_with_jazz=True,old_rtc_authentication=False)# 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)TestingUsing a virtualenv is recommended. Setuptools will automatically fetch
missing test dependencies.If you have installed thetoxon your system already, you can run
the tests usingpytestwith the following command:virtualenvsource.venv/bin/active(venv)tox-etest(venv)tox-eflake(venv)tox-epycodestyleTesting with PoetryWhen usingpoetry, all dependencies and test environment are managed by this tool even when usingtox.If you have already globally installedpoetryon your system, you can run
the tests usingpytestwith the following command:poetryinstall--withdevelpoetryruntox-etestpoetryruntox-eflakepoetryruntox-epycodestyle