https://github.com/best-doctor/best_testrail_client
TestRail client by BestDoctor
https://github.com/best-doctor/best_testrail_client
testrail testrail-api testrail-python
Last synced: about 1 year ago
JSON representation
TestRail client by BestDoctor
- Host: GitHub
- URL: https://github.com/best-doctor/best_testrail_client
- Owner: best-doctor
- License: mit
- Created: 2020-04-30T15:40:30.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-22T23:25:03.000Z (about 3 years ago)
- Last Synced: 2024-05-11T22:44:53.647Z (about 2 years ago)
- Topics: testrail, testrail-api, testrail-python
- Language: Python
- Homepage:
- Size: 138 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TestRail client by BestDoctor
[](https://travis-ci.org/best-doctor/best_testrail_client)
[](https://codeclimate.com/github/best-doctor/best_testrail_client/maintainability)
[](https://codeclimate.com/github/best-doctor/best_testrail_client/test_coverage)
[](https://badge.fury.io/py/best-testrail-client)
[](https://pypi.org/project/best-testrail-client/)
Implements [API v2](http://docs.gurock.com/testrail-api2/start) for [TestRail](https://www.gurock.com/testrail/).
## Installation
```bash
pip install best_testrail_client
```
## Prerequisites
1. Enabled API in your TestRail project.
1. Generated API key.
## Usage
```python
from best_testrail_client.client import TestRailClient
from best_testrail_client.enums import BaseResultStatus
from best_testrail_client.models.result import Result
from best_testrail_client.models.run import Run
# Client initialization
project_url = 'https://.testrail.io/' # or other URL for self-hosted
login = ''
api_token = ''
client = TestRailClient(project_url, login, api_token)
# Create Test Run
new_run = Run(
name='Test Run from API',
include_all=False,
case_ids=[1, 2, 3],
)
created_run = client.runs.add_run(run=new_run, project_id=1)
# You can set global Project ID
client.set_project_id(project_id=2)
# Add results for run
results = [
Result(status_id=BaseResultStatus.PASSED.value, case_id=1, comment='Passed test'),
Result(status_id=BaseResultStatus.FAILED.value, case_id=2, comment='Failed test'),
Result(status_id=6, case_id=3, comment='Waiting test'), # Custom status
]
client.results.add_results_for_cases(run_id=created_run.id, results=results)
# Close run
client.runs.close_run(run_id=created_run.id)
```
### Custom attributes
Custom attributes are stored in `custom` dictionary attribute in models.
It stores all data from API and converts it back.
```python
from best_testrail_client.client import TestRailClient
# Client initialization
project_url = 'https://.testrail.io/' # or other URL for self-hosted
login = ''
api_token = ''
client = TestRailClient(project_url, login, api_token)
created_run = client.runs.get_run(run_id=1)
"""
API response looks like:
{
...
'refs': 'SAN-1',
'custom_status1_count': 0,
'custom_status2_count': 0,
'custom_status3_count': 0,
'custom_status4_count': 0,
'custom_status5_count': 0,
'custom_status6_count': 0,
'custom_status7_count': 0,
'description': null,
...
}
It is now stored in custom attribute:
created_run.custom == {
'custom_status1_count': 0,
'custom_status2_count': 0,
'custom_status3_count': 0,
'custom_status4_count': 0,
'custom_status5_count': 0,
'custom_status6_count': 0,
'custom_status7_count': 0,
}
"""
```
## Contributing
We would love you to contribute to our project. It's simple:
1. Create an issue with bug you found or proposal you have.
Wait for approve from maintainer.
1. Create a pull request. Make sure all checks are green.
1. Fix review comments if any.
1. Be awesome.
Here are useful tips:
- You can run all checks and tests with `make check`.
Please do it before TravisCI does.
- We use [BestDoctor python styleguide](https://github.com/best-doctor/guides/blob/master/guides/en/python_styleguide.md).
- We respect [Django CoC](https://www.djangoproject.com/conduct/).
Make soft, not bullshit.