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

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

Built distribution (wheel)

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

Total release size: 22.0 kB

Release files / youtrack_sdk-1.0.202607080632.tar.gz

Download URL youtrack_sdk-1.0.202607080632.tar.gz
Size 10.4 kB
Tags Source
SHA-256 checksum
How to use checksums
7d587f7010fa0eb26336af292582e3fd1438beed6fd97cf24073da0331a4bd9e
BLAKE2b-256 checksum
How to use checksums
3102ced4ad154ff5c3c91c27740eca6625d2d855fba2327e17fc0545049f8641
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.4.1 CPython/3.12.3 Linux/6.17.0-1018-azure

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

Download URL youtrack_sdk-1.0.202607080632-py3-none-any.whl
Size 11.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c5fef81d8fb13eb00d7130a629ec96edd6b1c379e3269313529897e97d16313e
BLAKE2b-256 checksum
How to use checksums
51254dfcaf2243f005461206ddca540edf2550dc8e27eea0e8bb3da605510422
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.4.1 CPython/3.12.3 Linux/6.17.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