Xray-Bot

Synchronize atlassian xray test case tickets with your test code and upload the test results.

Install

$ pip install xray-bot

Example

from xraybot import XrayBot, TestEntity, TestResultEntity, XrayResultType

xray_bot = XrayBot("http://jira_server", "username", "pwd", "project_key")

xray_tests = xray_bot.get_xray_tests()

local_tests = [
    TestEntity(
        unique_identifier="com.foo.bar.TestClass#testFoo",
        summary="foo",
        description="desc",
        req_key="REQ-100",
    ),
    TestEntity(
        unique_identifier="com.foo.bar.TestClass#testBar",
        summary="Bar",
        description="desc",
        req_key="REQ-101",
    ),
]
xray_bot.sync_tests(local_tests)

test_results = [
    TestResultEntity(key="KEY-1", result=XrayResultType.PASS),
    TestResultEntity(key="KEY-2", result=XrayResultType.FAIL),
]
xray_bot.upload_automation_results("test_plan", "test_execution", test_results)

Development

$ pip install -e ".[dev]"
# test
$ invoke test
# lint
$ invoke lint
# reformat code
$ invoke reformat-code
# install
$ invoke install

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xray_bot-1.0.0.tar.gz (201.2 kB view details)

Uploaded Nov 12, 2025 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

xray_bot-1.0.0-py3-none-any.whl (16.5 kB view details)

Uploaded Nov 12, 2025 Python 3

File details

Details for the file xray_bot-1.0.0.tar.gz.

File metadata

Download URL: xray_bot-1.0.0.tar.gz
Upload date: Nov 12, 2025
Size: 201.2 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for xray_bot-1.0.0.tar.gz
Algorithm	Hash digest
SHA256	`92a6d7b37356d2e7a931d2dee47db4533a39a56bc9f3c2c0201f92f41f74ec01`
MD5	`e0f64df9794ed57b90b0ef2fb47d3d9d`
BLAKE2b-256	`3ac5e9c06d5a1cb84023faf38f838d255e5a7ad728fa82a857a93aebd3e95150`

See more details on using hashes here.

File details

Details for the file xray_bot-1.0.0-py3-none-any.whl.

File metadata

Download URL: xray_bot-1.0.0-py3-none-any.whl
Upload date: Nov 12, 2025
Size: 16.5 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for xray_bot-1.0.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`3b3ff1aa6b90716fd45d1797f0838cb8fb98a829e127193054262da56107b68a`
MD5	`d605c2e311d1c2216ac4ae9c27aacaed`
BLAKE2b-256	`1fdbd89e746cb748eef581b802ee49fc0b5737f500948891894212696f5bfd54`