Skip to main content

python package providing functionality for Jira Test Management (tm4j)

Project description


This python package provides functionality for Jira Test Management (tm4j).

Table of Contents


To install adaptavist, you can use the following command(s):

python -m pip install adaptavist

To uninstall adaptavist, you can use the following command:

python -m pip uninstall adaptavist

Getting Started

adaptavist is using the REST API of Adaptavist Test Management for Jira Server (see and Jira's internal REST API, both with HTTP Basic authentication.

In order to access Adaptavist/Jira, valid credentials are necessary. In addition, getpass.getuser().lower() must be a known Jira user as well.

Examples and Features

General Workflow

 from adaptavist import Adaptavist

 # create a new instance
 atm = Adaptavist(jira_server, jira_username, jira_password)

 # create a test plan
 test_plan_key = atm.create_test_plan(project_key="TEST", test_plan_name="my test plan")

 # create a test cycle (formerly test run) with a set of test cases and add it to test plan
 test_run_key = atm.create_test_run(project_key="TEST", test_run_name="my test cycle", test_cases=["TEST-T1"], test_plan_key=test_plan_key)

 # as test cycle creation also creates/initializes test results, we can just edit these
 atm.edit_test_script_status(test_run_key=test_run_key, test_case_key="TEST-T1", step=1, status="Pass")

 # (optional) edit/overwrite the overall execution status of the test case (by default this is done automatically when editing status of a single step)
 atm.edit_test_result_status(test_run_key=test_run_key, test_case_key="TEST-T1", status="Pass")

There's much more inside (like adding attachments, creating folders and environments, cloning test cycles). Additional code examples will follow.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adaptavist-2.3.3.tar.gz (27.5 kB view hashes)

Uploaded source

Built Distribution

adaptavist-2.3.3-py3-none-any.whl (13.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page