Skip to main content

testrail-api-client

testrail-api-client - is a client for provide integration with TestRail

General information about TestRail Api

Requirements

  • requests
  • pytest
  • gherkin-official
  • pytest-bdd

Installation

pip install pytest-testrail-api-client

Configuration Starting from version 0.3 you can configure testrail client credentials with 3 way:

Way 1. Directly set credentials in class constructor

from pytest_testrail_api_client.test_rail import TestRail
test_rail = TestRail('your_host', 'your_username', 'your_token')

Way 2. Set credentials in pytest.ini or in test_rail.ini This files must be in root folder project path Add group [pytest] Add variables:

  • testrail-email
  • testrail-key
  • testrail-url

Example pytest.ini or test_rail.ini

[saucelab]
testrail-email = your_email
testrail-key = your_token
testrail-url = your_host

When you add credentials to ini file:

from pytest_testrail_api_client.test_rail import TestRail
test_rail = TestRail()

Way 3. You can set environment variables:

  • TESTRAIL_EMAIL
  • TESTRAIL_KEY
  • TESTRAIL_URL

When you add credentials to environment variables:

from pytest_testrail_api_client.test_rail import TestRail
test_rail = TestRail()

Features in version: 0.3.1

  • Access to TestRail Api
  • Export feature files to TestRail (use pytest --pytest_testrail_export_test_cases --pytest-testrail-feature-files-relative-path "%RELATIVE_PATH%")
  • Export tests results to TestRail (use pytest --pytest-testrail-export-test-results --pytest-testrail-test-plan-id %PLAN_ID% --pytest-testrail-test-configuration-name %CONFIGURATION%)
  • Scenarios validation (please, see pytest_testrail_api_client/client_config.py)
  • Tags replacing (for example: you have automation status "To Be Automated" and you use tag "to_automate" if feactures you can set it in variable REPLACE_TAGS - it will bind these tags)
  • Priority replace: variable PRIORITY_REPLACE

Usage examples

from pytest_testrail_api_client.test_rail import TestRail
test_rail = TestRail()
case = test_rail.cases.get_case(1)

Metadata

Release files for pytest-testrail-api-client 0.3.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pytest-testrail-api-client 0.3.6
File Size Uploaded
pytest-testrail-api-client-0.3.6.tar.gz 26.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pytest-testrail-api-client 0.3.6
File Interpreter ABI Platform
pytest_testrail_api_client-0.3.6-py3-none-any.whl Python 3 none any Details

Total release size: 65.3 kB

Release files / pytest-testrail-api-client-0.3.6.tar.gz

Download URL pytest-testrail-api-client-0.3.6.tar.gz
Size 26.5 kB
Tags Source
SHA-256 checksum
How to use checksums
6974728d1af2063adbee961cc2f495594724987c888719d4e013a491010aaa55
BLAKE2b-256 checksum
How to use checksums
ba949c6d2df6489533fddd516d3bcf7150984cb229310c8e0949f21fd8136cc9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.1

Release files / pytest_testrail_api_client-0.3.6-py3-none-any.whl

Download URL pytest_testrail_api_client-0.3.6-py3-none-any.whl
Size 38.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f598287c00f407f99745bb73fb45e1c24afeb8a302a490aa11246c7d43b5c652
BLAKE2b-256 checksum
How to use checksums
e8fd1201e7cdb4bea4107af701708b2e35ab597cd7c7fc9fbe304d632088894b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.1

Release history Release notifications | RSS feed

0.3.9

2 release files

0.3.8

2 release files

0.3.7

2 release files

This release

0.3.6 This release

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3

2 release files

0.2

2 release files

0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page