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

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

Built distribution (wheel)

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

Total release size: 22.0 kB

Release files / youtrack_sdk-1.0.202602120958.tar.gz

Download URL youtrack_sdk-1.0.202602120958.tar.gz
Size 10.4 kB
Tags Source
SHA-256 checksum
How to use checksums
a6f0e8261c3caf619942d95f1d33c3207ecb72a4886b999970fa6e80d37c06b9
BLAKE2b-256 checksum
How to use checksums
c7562275aa88a4ed33160ac6eaa04c97a661358f860afcf6ebd413dffd787e11
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.202602120958-py3-none-any.whl

Download URL youtrack_sdk-1.0.202602120958-py3-none-any.whl
Size 11.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d7d7ebd9bfbb53436aca67be9866778284043845bc45bfd8dc068652b9d12ec2
BLAKE2b-256 checksum
How to use checksums
395f8d36ec1f1537772d5e049fe93196a7dece173be0b797a01617b3f52a128c
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