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

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.202602201123
File Size Uploaded
youtrack_sdk-1.0.202602201123.tar.gz 10.4 kB Details

Built distribution (wheel)

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

Total release size: 22.0 kB

Release files / youtrack_sdk-1.0.202602201123.tar.gz

Download URL youtrack_sdk-1.0.202602201123.tar.gz
Size 10.4 kB
Tags Source
SHA-256 checksum
How to use checksums
1b5fb493694001fb6073a11811fb78efaad2e1053de7e283679903c91c8a12fb
BLAKE2b-256 checksum
How to use checksums
1df8cd1fd83442cdac0ab3f2441988b366fe72aeef37ad62d04c72b19048b3c9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.2.1 CPython/3.12.3 Linux/6.11.0-1018-azure

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

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