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

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

Built distribution (wheel)

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

Total release size: 21.9 kB

Release files / youtrack_sdk-1.0.202508120734.tar.gz

Download URL youtrack_sdk-1.0.202508120734.tar.gz
Size 10.3 kB
Tags Source
SHA-256 checksum
How to use checksums
95c950c9365bc99fc465f6205dbb31a2dd4b80286ca04ed3a1eb676342a1fffb
BLAKE2b-256 checksum
How to use checksums
72c310c39581a81b40ef0282bbe80d2b2480af6c1ea6ab79916c89dc7dc8837b
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.202508120734-py3-none-any.whl

Download URL youtrack_sdk-1.0.202508120734-py3-none-any.whl
Size 11.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1573daa89b41354a5a3de3d5577d838fc7409227ce79bcd39aa5e3174d567dbf
BLAKE2b-256 checksum
How to use checksums
83681bd68680ae5beecac810066cd22e43e8836ac5cf4b7c615520f0046cd484
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