Skip to main content

YouTrack SDK

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

youtrack_sdk-1.0.202507151231.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

youtrack_sdk-1.0.202507151231-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file youtrack_sdk-1.0.202507151231.tar.gz.

File metadata

  • Download URL: youtrack_sdk-1.0.202507151231.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.3 Linux/6.11.0-1018-azure

File hashes

Hashes for youtrack_sdk-1.0.202507151231.tar.gz
Algorithm Hash digest
SHA256 d365fe6f930a081e3f86068db000f448bb3f521348e42c9312ae81ba41effb17
MD5 599eda349a7ca0e9801e7c21a9e78152
BLAKE2b-256 811a60a87dba3ac60ba2ea0818e4b5eb364458016bb171dbd4b85507c8ef1001

See more details on using hashes here.

File details

Details for the file youtrack_sdk-1.0.202507151231-py3-none-any.whl.

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202507151231-py3-none-any.whl
Algorithm Hash digest
SHA256 da4665fd05857375d7a99ed1075e79685e2273196941bb82488ddb8501b95acc
MD5 637fae23c7c4a222f6d05d1dbd82f2a1
BLAKE2b-256 30b28571233209687f09a514e9b6781c6d72242d41e1c9787cb99f9f695cbcb3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page