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

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.202503061244
File	Size	Uploaded
youtrack_sdk-1.0.202503061244.tar.gz	10.3 kB	Mar 6, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for youtrack-sdk 1.0.202503061244
File	Interpreter	ABI	Platform	Reset
youtrack_sdk-1.0.202503061244-py3-none-any.whl 11.6 kB Mar 6, 2025	Python 3	none	any	Details

Total release size: 21.9 kB

Release files / youtrack_sdk-1.0.202503061244.tar.gz

Download URL	youtrack_sdk-1.0.202503061244.tar.gz
Size	10.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`ebf4c62c9ce80251870bfb66825a32ff06c65f186093532f0c549f5ec665e6fd`
BLAKE2b-256 checksum How to use checksums	`78ebfa6d664a5399555ae501a0880b6f156737458b457442ff63cebf2fb1ea79`
Upload date	Mar 6, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.1.1 CPython/3.12.3 Linux/6.8.0-1021-azure`

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

Download URL	youtrack_sdk-1.0.202503061244-py3-none-any.whl
Size	11.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`fbef434e28dff786031a8cf373ee4988c25cb5df99d6b5aa264446fa66bf9ed2`
BLAKE2b-256 checksum How to use checksums	`676ded723dbcc05c078963107c5ff0d07862df1449fd90771643ad6177604901`
Upload date	Mar 6, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.1.1 CPython/3.12.3 Linux/6.8.0-1021-azure`