Skip to main content

PyTest plugin for TestRail

Project description


PyTest plugin for integration with TestRail


  1. Installing pip install pytest-testrail-plugin

  2. Create config file .cfg test/testrail_config.cfg:

url =
email =
password = pass

project_id = your ID
root_section = directory_name
  1. Use decorator for tests

    from pytest_testrail_plugin.plugin import pytestrail

  2. Use docstring in yaml or json format if you want customize test case

    from pytest_testrail_plugin.plugin import pytestrail
    def test_foo():
       title: case title in TestRail
       custom_preconds: preconditions info
       custom_steps: steps info
       custom_expected: this is too long a string 
           to print in a single line
       assert 1 == 1
  3. Run test with flags

    py.test --testrail --tr-config=path/to/config/file.cfg

    If you want to delete unused cases and sections use --tr-unsafe flag:

    py.test --testrail --tr-config=path/to/config/file.cfg --tr-unsafe

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

pytest_testrail_plugin-0.0.3.tar.gz (11.7 kB view hashes)

Uploaded Source

Built Distribution

pytest_testrail_plugin-0.0.3-py3-none-any.whl (12.2 kB view hashes)

Uploaded Python 3

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