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

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.202311200819
File	Size	Uploaded
youtrack_sdk-1.0.202311200819.tar.gz	9.4 kB	Nov 20, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for youtrack-sdk 1.0.202311200819
File	Interpreter	ABI	Platform	Reset
youtrack_sdk-1.0.202311200819-py3-none-any.whl 10.2 kB Nov 20, 2023	Python 3	none	any	Details

Total release size: 19.6 kB

Release files / youtrack_sdk-1.0.202311200819.tar.gz

Download URL	youtrack_sdk-1.0.202311200819.tar.gz
Size	9.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`ff8ef088b2cbe26e3070bc75078a2104f3b09f98907a5b4632625b071ea456e4`
BLAKE2b-256 checksum How to use checksums	`5c8118e8ebb7607d6b023223531af00456bf3ecf9c7f1519da405dade924ea89`
Upload date	Nov 20, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.6.1 CPython/3.10.12 Linux/6.2.0-1015-azure`

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

Download URL	youtrack_sdk-1.0.202311200819-py3-none-any.whl
Size	10.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`df2875a220110fa20833026cc77d6ce1e5c2454dcb6129d357d739ba6e656e82`
BLAKE2b-256 checksum How to use checksums	`131399669c1a6c2b1b2a57f4b868633c4fab3ca5dfe2e67a83b9b11ffff263f2`
Upload date	Nov 20, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.6.1 CPython/3.10.12 Linux/6.2.0-1015-azure`