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.202508190620.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.202508190620-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for youtrack_sdk-1.0.202508190620.tar.gz
Algorithm Hash digest
SHA256 0bb6f7210f4f5c62622f8b627f91ee5bbf48b53180ae82d80c6e1081186591f8
MD5 7f6f3bbfbc6d94c197ab0072e9e9011f
BLAKE2b-256 fd75a7b8c56ce4e74f93b58100d3a61dbcb4078da4a6c46bc0f99c0e1bb66a16

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202508190620-py3-none-any.whl
Algorithm Hash digest
SHA256 a43f1658ad4d61ea9e71391c0a1acea2336844adfea318f09341d8560fa1df06
MD5 159e4b31d25015bdd389999786ae4227
BLAKE2b-256 0f869e8dd71218772f445c4651b0496e0867eb304d63785b8bd9ed99853054e2

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