Examples

Authentication

Zephyr Cloud auth requires generating an API access token (see the how-to).

from zephyr import ZephyrScale

zscale = ZephyrScale(token="<your_token>")

Zephyr Server/Data Center (TM4J) auth:

from zephyr import ZephyrScale

# Auth can be made with Jira token
auth = {"token": "<your_jira_token>"}

# or with login and password (suggest using get_pass)
auth = {"username": "<your_login>", "password": "<your_password>"}

# or even session cookie dict
auth = {"cookies": "<session_cookie_dict>"}

zscale = ZephyrScale.server_api(base_url="<your_base_url>", **auth)

Usage

Then it is possible to interact with the low-level api wrappers:

zapi = zscale.api

# Get all test cases
all_test_cases = zapi.test_cases.get_test_cases()

# Get a single test case by its id
test_case = zapi.test_cases.get_test_case("<test_case_id>")

# Create a test case
creation_result = zapi.test_cases.create_test_case("<project_key>", "test_case_name")

Each Zephyr Scale API wrapper group could be accessed as a property:

zapi = zscale.api

# Test Cases
test_case = zapi.test_cases

# Test Cycles
test_cycles = zapi.test_cycles

Be aware that depending on your API type (Cloud or Server/Datacenter) the amount of wrapper groups and their naming is different.