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

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.202408050654
File	Size	Uploaded
youtrack_sdk-1.0.202408050654.tar.gz	10.6 kB	Aug 5, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for youtrack-sdk 1.0.202408050654
File	Interpreter	ABI	Platform	Reset
youtrack_sdk-1.0.202408050654-py3-none-any.whl 11.8 kB Aug 5, 2024	Python 3	none	any	Details

Total release size: 22.4 kB

Release files / youtrack_sdk-1.0.202408050654.tar.gz

Download URL	youtrack_sdk-1.0.202408050654.tar.gz
Size	10.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`490fd522f68fd2e7f5d35d5f4b046837816fbf481b43f7b5fcb5a2f963c2c451`
BLAKE2b-256 checksum How to use checksums	`35da34844a5be661dcba1c4d152653c914ba36aa8f1b642de766dff422bfdeb0`
Upload date	Aug 5, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.2 CPython/3.10.12 Linux/6.5.0-1025-azure`

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

Download URL	youtrack_sdk-1.0.202408050654-py3-none-any.whl
Size	11.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`a91a1ff23929a6dee14eaf980c51a14d0011a05eed29109f84530d6959c16e39`
BLAKE2b-256 checksum How to use checksums	`3c6f47dcdb5002da2f8aeeae9fa8a5b29b5af887f82826fe594bca54251b366c`
Upload date	Aug 5, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.2 CPython/3.10.12 Linux/6.5.0-1025-azure`