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

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.202401030627
File	Size	Uploaded
youtrack_sdk-1.0.202401030627.tar.gz	9.6 kB	Jan 3, 2024	Details

Built distribution (wheel)

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

Total release size: 20.2 kB

Release files / youtrack_sdk-1.0.202401030627.tar.gz

Download URL	youtrack_sdk-1.0.202401030627.tar.gz
Size	9.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`af2a184fd97f2935ca39b12b3a58c6c14d3ef6c228584cb59f78e6c7ee9bf104`
BLAKE2b-256 checksum How to use checksums	`8dad249a33b6a09f8ba339b8005425d7afb9580fb325bd3b5c378399b6e44c86`
Upload date	Jan 3, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.6.1 CPython/3.10.12 Linux/6.2.0-1018-azure`

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

Download URL	youtrack_sdk-1.0.202401030627-py3-none-any.whl
Size	10.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`e7b60632329f80b1dfc1fd69477ed20c6ce6d19389b0eccd0707a2117d1fa7d8`
BLAKE2b-256 checksum How to use checksums	`13c5d1079f6b590617b182922d952895ec290a866cf0988e7c836e29dece2e22`
Upload date	Jan 3, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.6.1 CPython/3.10.12 Linux/6.2.0-1018-azure`