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

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

Built distribution (wheel)

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

Total release size: 22.0 kB

Release files / youtrack_sdk-1.0.202606220634.tar.gz

Download URL youtrack_sdk-1.0.202606220634.tar.gz
Size 10.4 kB
Tags Source
SHA-256 checksum
How to use checksums
bd18194f717864d06c673cbf684dfc5e9884974e7449e3805131f3f4c98db96a
BLAKE2b-256 checksum
How to use checksums
46dcdc21c4019e2cd5fe29727c2b4616ef9f0d17f11020b8c2a2e841bf6c139b
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-1018-azure

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

Download URL youtrack_sdk-1.0.202606220634-py3-none-any.whl
Size 11.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8dc074bdc62e13a3f3e77e868c3d9add961d45f488d0f71c6e39014e17da574a
BLAKE2b-256 checksum
How to use checksums
599159cf0df6dec33914abafadae1b932bd41900f19b90e71bdb1d328c605e2e
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-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