Skip to main content

YouTrack REST API Client

A client library for accessing YouTrack REST API.

Usage

from datetime import date
from youtrack_sdk import Client
from youtrack_sdk.entities import (
    DateIssueCustomField,
    EnumBundleElement,
    Issue,
    Tag,
    Project,
    SingleEnumIssueCustomField,
    SingleUserIssueCustomField,
    StateBundleElement,
    StateIssueCustomField,
    User,
)

client = Client(base_url="https://dummy.myjetbrains.com/youtrack", token="dummy")
result = client.create_issue(
    issue=Issue(
        project=Project(id="0-0"),
        summary="Created from YouTrack SDK",
        description="Description **text**.",
        tags=[
            Tag(id="6-0"),
        ],
        custom_fields=[
            StateIssueCustomField(
                name="State",
                value=StateBundleElement(
                    name="In Progress",
                ),
            ),
            SingleUserIssueCustomField(
                name="Assignee",
                value=User(
                    ring_id="00000000-a31c-4174-bb27-abd3387df67a",
                ),
            ),
            SingleEnumIssueCustomField(
                name="Type",
                value=EnumBundleElement(
                    name="Bug",
                ),
            ),
            DateIssueCustomField(
                name="Due Date",
                value=date(2005, 12, 31),
            ),
        ],
    ),
)

Note

  • You should prefer to use internal entity IDs everywhere. Some methods accept readable issue IDs (e.g. HD-99) but it's not supported everywhere.

Metadata

Release files for youtrack-sdk 1.0.202507151231

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for youtrack-sdk 1.0.202507151231
File Size Uploaded
youtrack_sdk-1.0.202507151231.tar.gz 10.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for youtrack-sdk 1.0.202507151231
File Interpreter ABI Platform
youtrack_sdk-1.0.202507151231-py3-none-any.whl Python 3 none any Details

Total release size: 21.9 kB

Release files / youtrack_sdk-1.0.202507151231.tar.gz

Download URL youtrack_sdk-1.0.202507151231.tar.gz
Size 10.3 kB
Tags Source
SHA-256 checksum
How to use checksums
d365fe6f930a081e3f86068db000f448bb3f521348e42c9312ae81ba41effb17
BLAKE2b-256 checksum
How to use checksums
811a60a87dba3ac60ba2ea0818e4b5eb364458016bb171dbd4b85507c8ef1001
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.12.3 Linux/6.11.0-1018-azure

Release files / youtrack_sdk-1.0.202507151231-py3-none-any.whl

Download URL youtrack_sdk-1.0.202507151231-py3-none-any.whl
Size 11.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
da4665fd05857375d7a99ed1075e79685e2273196941bb82488ddb8501b95acc
BLAKE2b-256 checksum
How to use checksums
30b28571233209687f09a514e9b6781c6d72242d41e1c9787cb99f9f695cbcb3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.12.3 Linux/6.11.0-1018-azure
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page