testrail-api
Python wrapper of the TestRail API
Decision gist · record as of 2026-08-14
Yes. The package is actively maintained, has no security vulnerabilities, installs with minimal friction, and is the standard way to interact with TestRail from Python. Install it if you need to automate TestRail operations or integrate TestRail into a CI/CD pipeline.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires TestRail instance URL, email, and password; alternatively set TESTRAIL_URL, TESTRAIL_EMAIL, and TESTRAIL_PASSWORD environment variables.
- Low friction install with a single runtime dependency (requests).
- The package is actively maintained with recent commits, marked as Production/Stable, and supports current Python versions from 3.9 through 3.14.
License · maintenance · safety
MIT License (permissive) — MIT License (permissive) means you can use, modify, and distribute this package freely in commercial and private projects with minimal restrictions.
last release 2026-01-16 (210 days) · last repo commit 2026-07-06 · 37 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 2,602,959 downloads/mo, #2,972 on PyPI
Alternatives
Verify before relying
pip install testrail-api
from testrail_api import TestRailAPI
api = TestRailAPI("https://example.testrail.com/", "example@mail.com", "password")
new_milestone = api.milestones.add_milestone(project_id=1, name="New milestone")- Whether the package supports TestRail's full API surface or a subset of endpoints.
- Rate limiting or connection pooling behavior when making many concurrent requests.
- Authentication method support beyond basic email/password (e.g., API tokens).
What it is and what it does
testrail-api is a Python client library that wraps the TestRail test management API, letting you automate interactions with TestRail from Python code. It exposes the API's main resources—milestones, test runs, test results, and attachments—as object methods, so you can create test runs, add results, attach screenshots, and update milestones without manually constructing HTTP requests.
The package depends only on requests and supports Python 3.9 and later. It can read credentials from environment variables or accept them directly at initialization, and it allows custom response handlers for non-standard error handling. The library is actively maintained, has no known vulnerabilities, and is classified as Production/Stable.
Use it for
- Automate test result reporting by creating runs and adding results directly from test frameworks or CI/CD pipelines.
- Bulk-manage milestones and test runs programmatically rather than through the TestRail UI.
- Attach screenshots or logs to test results automatically during test execution.
- Build custom test reporting dashboards or integrations that query TestRail data.
- Integrate TestRail with continuous integration systems to track test execution and results.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
The package is actively maintained, has no security vulnerabilities, installs with minimal friction, and is the standard way to interact with TestRail from Python. Install it if you need to automate TestRail operations or integrate TestRail into a CI/CD pipeline.
Install
testrail-api on PyPI
Before you install
Low friction install with a single runtime dependency (requests). The package is actively maintained with recent commits, marked as Production/Stable, and supports current Python versions from 3.9 through 3.14.
Requires TestRail instance URL, email, and password; alternatively set TESTRAIL_URL, TESTRAIL_EMAIL, and TESTRAIL_PASSWORD environment variables.
License in practice
MIT License (permissive) means you can use, modify, and distribute this package freely in commercial and private projects with minimal restrictions.
Quickstart
pip install testrail-api
from testrail_api import TestRailAPI
api = TestRailAPI("https://example.testrail.com/", "example@mail.com", "password")
new_milestone = api.milestones.add_milestone(project_id=1, name="New milestone")Verify before relying
- Whether the package supports TestRail's full API surface or a subset of endpoints.
- Rate limiting or connection pooling behavior when making many concurrent requests.
- Authentication method support beyond basic email/password (e.g., API tokens).
Package facts
| License | MIT License permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagerequests |
| Maintenance | Actively maintained 210 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 2,602,959 / month, #2,972 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableIntended Audience :: DevelopersLicense :: OSI Approved :: MIT LicenseNatural Language :: EnglishOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Programming Language :: Python :: 3.9Programming Language :: Python :: Implementation :: CPythonProgramming Language :: Python :: Implementation :: PyPyTopic :: Software Development :: Libraries :: Python Modules |
Evidence: testrail_api-1.13.6-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “testrail api client”
- testrail-apiA Python wrapper for the TestRail API that lets you programmatically…
- pytest-testrailA pytest plugin that integrates test execution with TestRail,…
- pytest-pytestrailA pytest plugin that decorates test functions to report results to…
Give your agent the search over MCP, or paste the wish link into any chat.
More Python Modules packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
PyYAML parses and emits YAML 1.1 data format, enabling serialization and deserialization of configuration files and Python objects to and from human-readable YAML text.
Pydantic validates Python data structures against type hints, coercing and checking input at runtime to ensure it matches a declared schema.
Provides reusable metadata objects for use with PEP-593 `typing.Annotated` to express common constraints like bounds, collection sizes, and predicates on types.
Install it if you use or build libraries that need to express type constraints in a standardized, inspectable way—or if you want to annotate your own types with…
Provides runtime tools to inspect and introspect Python type annotations, enabling programmatic examination of type hints at execution time.
See also pytest-pytestrail · pytest-testrail · trcli · pybacklogpy · pytest-html-reporter · qase-api-client · allure-robotframework · qase-pytest · pytest-freezer · qase-api-v2-client