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

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

Built distribution (wheel)

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

Total release size: 21.9 kB

Release files / youtrack_sdk-1.0.202509091024.tar.gz

Download URL youtrack_sdk-1.0.202509091024.tar.gz
Size 10.3 kB
Tags Source
SHA-256 checksum
How to use checksums
9d287c012a420b7564c1e89dcd8e3803c04bbe383491791a9c4f331114e90e31
BLAKE2b-256 checksum
How to use checksums
f65026544865f0f3d01998b889742848aaf8ce999183434a92a3745365624b47
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.202509091024-py3-none-any.whl

Download URL youtrack_sdk-1.0.202509091024-py3-none-any.whl
Size 11.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d58a062a9ee6e0ebbb2e42842b38e418c6ef2aa86277cfce10bde2fa4c27231a
BLAKE2b-256 checksum
How to use checksums
28dffed4605cf802b8e738012a497f3793956a2451440123dbc3dcd4844b33f0
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