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

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

Built distribution (wheel)

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

Total release size: 22.0 kB

Release files / youtrack_sdk-1.0.202604210923.tar.gz

Download URL youtrack_sdk-1.0.202604210923.tar.gz
Size 10.4 kB
Tags Source
SHA-256 checksum
How to use checksums
3d746c786c7035786d752a4169f734ff183ef0a3868e7af9b410f6d98cc857be
BLAKE2b-256 checksum
How to use checksums
8a8e271c064fac3263e43f557c3813acbdb75227849497d7064c3d50b47db091
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.2.1 CPython/3.12.3 Linux/6.17.0-1010-azure

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

Download URL youtrack_sdk-1.0.202604210923-py3-none-any.whl
Size 11.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
172611489384bad5cd42b4aae5b969d8266bf95004de43e990325a80e60c918b
BLAKE2b-256 checksum
How to use checksums
b3d203d3a64f1002f91129af3fc16cb3baa0dfe92ff832adb7c4fe1367cae6a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.2.1 CPython/3.12.3 Linux/6.17.0-1010-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