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.202508190620

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.202508190620
File Size Uploaded
youtrack_sdk-1.0.202508190620.tar.gz 10.3 kB Details

Built distribution (wheel)

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

Total release size: 21.9 kB

Release files / youtrack_sdk-1.0.202508190620.tar.gz

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

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

Download URL youtrack_sdk-1.0.202508190620-py3-none-any.whl
Size 11.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a43f1658ad4d61ea9e71391c0a1acea2336844adfea318f09341d8560fa1df06
BLAKE2b-256 checksum
How to use checksums
0f869e8dd71218772f445c4651b0496e0867eb304d63785b8bd9ed99853054e2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.4 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