Skip to main content
Ask AI

TestRelic for Python

TestRelic ships four pytest-native Python packages. Each one installs from PyPI, activates automatically through pytest's plugin system (no conftest.py wiring), and uploads to the same TestRelic cloud workspace as the JavaScript SDKs. Pick the package that matches what you test.


Not sure which to pick?
  • Use pytest for any Python test suite — unit, integration, or API. If your tests make httpx or requests calls, they're automatically surfaced as API tests with full request/response capture.
  • Use Playwright (Python) if you drive browsers with playwright + pytest-playwright.
  • Use DeepEval if you run LLM evaluations with DeepEval and want the results in TestRelic.
  • Use Appium (Python) if you test native Android or iOS apps with the Appium Python client.

Shared conventions

All four packages follow the same conventions, so what you learn for one carries over:

ConventionDetail
Installpip install <package> — the plugin auto-registers via a pytest11 entry point.
Cloud authSet TESTRELIC_API_KEY (create a key under API Keys).
Cloud endpointDefaults to https://platform.testrelic.ai/api/v1.
Offline queueFailed uploads are queued locally and replayed with the package's drain command.
CI metadataBranch, commit, and CI context are auto-detected (GitHub Actions, GitLab CI, Jenkins, CircleCI, and more).

Once a run uploads, it appears in the Test Runs dashboard and opens in the matching Session Workspace — the API workspace for API tests, the eval workspace for DeepEval runs.

Prefer JavaScript or TypeScript? See the SDK section for the Playwright, Appium, and Maestro reporters.

Was this page helpful?
Last updated on by Srivishnu Ayyagari