zephyr-python-api

What it is and what it does

Zephyr-python-api is a thin wrapper library around the Zephyr Scale (TM4J) REST API, enabling test automation engineers to interact with Zephyr Scale test management via Python code instead of the web GUI. It abstracts away HTTP request construction and authentication, exposing a higher-level interface for common operations like fetching, creating, and managing test cases and cycles. The library supports both Zephyr Cloud and Zephyr Server deployments, with flexible authentication options including API tokens, Jira credentials, and session cookies.

The package depends only on requests, making it lightweight to install. However, it is in early development (version 0.1.0) and has been dormant since its latest release, with the author noting that tests, documentation, and higher-level object wrappers remain incomplete. It is suitable for teams already committed to Zephyr Scale who want to script routine test management tasks, but should be treated as a work-in-progress tool rather than a mature, production-hardened library.

Use it for:

• Automate bulk creation or updates of test cases in Zephyr Scale from external data sources or CI/CD pipelines.
• Script test cycle management and test execution reporting without manual GUI interaction.
• Integrate Zephyr Scale test metadata into custom reporting or analytics dashboards.
• Build custom test orchestration workflows that query test cases and cycles programmatically.
• Migrate test data between Zephyr Scale instances or from legacy test management systems.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides Python wrappers for the Zephyr Scale (TM4J) REST API, allowing programmatic interaction with test cases, cycles, and other Zephyr Scale resources without using the GUI.

Yes, if you use Zephyr Scale and need programmatic access to automate test management tasks. No, if you expect a mature, actively maintained library—the 0.1.0 version and dormant maintenance signal incomplete coverage and no active support. Suitable for teams willing to work around gaps; risky for production workflows that depend on stability.

Install

zephyr-python-api on PyPI

pip install zephyr-python-api

uv add zephyr-python-api

poetry add zephyr-python-api

Installing zephyr-python-api

Before you install

Low install friction with a single dependency (requests). Maintenance is dormant—last commit was 2024-05-06—so expect no active bug fixes or feature updates, though the repository is not archived.

License in practice

Licensed under Apache 2.0 (permissive), so you can use, modify, and distribute the package freely in commercial and private projects with minimal restrictions.

Quickstart

pip install zephyr-python-api

from zephyr import ZephyrScale

# Cloud auth
zscale = ZephyrScale(token="<your_token>")
zapi = zscale.api
all_test_cases = zapi.test_cases.get_test_cases()

Requires a valid Zephyr Scale (Cloud or Server) account and authentication token or credentials.

Verify before relying

• Extent of API coverage—which Zephyr Scale endpoints are wrapped and which are missing.
• Stability and backward compatibility guarantees given the early 0.1.0 version and dormant maintenance status.
• Quality and completeness of error handling and edge-case behavior.

Package facts

Evidence: zephyr_python_api-0.1.0-py3-none-any.whl

Tags

More Quality Assurance packages