# adaptavist
This python package provides functionality for Jira Test Management ([tm4j](https://www.adaptavist.com/doco/display/KT/Managing+Tests+From+the+REST+API)).
## Table of Contents
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Examples and Features](#examples-and-features)
- [General Workflow](#general-workflow)
## Installation
To install adaptavist, you can use the following command(s):
```bash
python -m pip install adaptavist
```
To uninstall adaptavist, you can use the following command:
```bash
python -m pip uninstall adaptavist
```
## Getting Started
adaptavist is using the REST API of Adaptavist Test Management for Jira Server (see https://docs.adaptavist.io/tm4j/server/api/) 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
```python
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/devolo/adaptavist",
"name": "adaptavist",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "python adaptavist kanoah tm4j jira test testmanagement report",
"author": "Stephan Steinberg, Guido Schmitz, Markus Bong",
"author_email": "guido.schmitz@devolo.de, markus.bong@devolo.de",
"download_url": "https://files.pythonhosted.org/packages/99/42/087232198ec165a6520dac072ae2a3256a7db8780793e908cb19d64d38a6/adaptavist-2.3.3.tar.gz",
"platform": "any",
"description": "# adaptavist\n\nThis python package provides functionality for Jira Test Management ([tm4j](https://www.adaptavist.com/doco/display/KT/Managing+Tests+From+the+REST+API)).\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Getting Started](#getting-started)\n- [Examples and Features](#examples-and-features)\n- [General Workflow](#general-workflow)\n\n## Installation\n\nTo install adaptavist, you can use the following command(s):\n\n```bash\npython -m pip install adaptavist\n```\n\nTo uninstall adaptavist, you can use the following command:\n\n```bash\npython -m pip uninstall adaptavist\n```\n\n## Getting Started\n\nadaptavist is using the REST API of Adaptavist Test Management for Jira Server (see https://docs.adaptavist.io/tm4j/server/api/) and Jira's internal REST API, both with HTTP Basic authentication.\n\nIn order to access Adaptavist/Jira, valid credentials are necessary. In addition, `getpass.getuser().lower()` must be a known Jira user as well.\n\n## Examples and Features\n\n### General Workflow\n\n ```python\n from adaptavist import Adaptavist\n\n # create a new instance\n atm = Adaptavist(jira_server, jira_username, jira_password)\n\n # create a test plan\n test_plan_key = atm.create_test_plan(project_key=\"TEST\", test_plan_name=\"my test plan\")\n\n # create a test cycle (formerly test run) with a set of test cases and add it to test plan\n 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)\n\n # as test cycle creation also creates/initializes test results, we can just edit these\n atm.edit_test_script_status(test_run_key=test_run_key, test_case_key=\"TEST-T1\", step=1, status=\"Pass\")\n\n # (optional) edit/overwrite the overall execution status of the test case (by default this is done automatically when editing status of a single step)\n atm.edit_test_result_status(test_run_key=test_run_key, test_case_key=\"TEST-T1\", status=\"Pass\")\n\n ```\n\nThere's much more inside (like adding attachments, creating folders and environments, cloning test cycles). Additional code examples will follow.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "python package providing functionality for Jira Test Management (tm4j)",
"version": "2.3.3",
"project_urls": {
"Homepage": "https://github.com/devolo/adaptavist"
},
"split_keywords": [
"python",
"adaptavist",
"kanoah",
"tm4j",
"jira",
"test",
"testmanagement",
"report"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9f60df2b801e0e3448a04d8210ef58d6d604ce0911bc97c262c803d25d7fb91f",
"md5": "0b18a6dc099111341b805346040cfa07",
"sha256": "d102ee8401bac824aacba2ffd0ec9e3d34e99a543456298b0ad6105e15c4a1c6"
},
"downloads": -1,
"filename": "adaptavist-2.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b18a6dc099111341b805346040cfa07",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 13368,
"upload_time": "2023-09-12T08:48:12",
"upload_time_iso_8601": "2023-09-12T08:48:12.186209Z",
"url": "https://files.pythonhosted.org/packages/9f/60/df2b801e0e3448a04d8210ef58d6d604ce0911bc97c262c803d25d7fb91f/adaptavist-2.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9942087232198ec165a6520dac072ae2a3256a7db8780793e908cb19d64d38a6",
"md5": "f09788b64d058b66c5d96442127fb84e",
"sha256": "fbcf567f4b238a6898cd15a6fb2bb37788e059633be5b0dab9240e6e2906ebd8"
},
"downloads": -1,
"filename": "adaptavist-2.3.3.tar.gz",
"has_sig": false,
"md5_digest": "f09788b64d058b66c5d96442127fb84e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 27545,
"upload_time": "2023-09-12T08:48:13",
"upload_time_iso_8601": "2023-09-12T08:48:13.797364Z",
"url": "https://files.pythonhosted.org/packages/99/42/087232198ec165a6520dac072ae2a3256a7db8780793e908cb19d64d38a6/adaptavist-2.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-12 08:48:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "devolo",
"github_project": "adaptavist",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "adaptavist"
}
JSON
