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

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtrack_sdk-1.0.202508120734.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.202508120734.tar.gz
Algorithm Hash digest
SHA256 95c950c9365bc99fc465f6205dbb31a2dd4b80286ca04ed3a1eb676342a1fffb
MD5 9bc90123c757587b7002575ba7c3c05a
BLAKE2b-256 72c310c39581a81b40ef0282bbe80d2b2480af6c1ea6ab79916c89dc7dc8837b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202508120734-py3-none-any.whl
Algorithm Hash digest
SHA256 1573daa89b41354a5a3de3d5577d838fc7409227ce79bcd39aa5e3174d567dbf
MD5 97d16f6546670586444864ad03662ef1
BLAKE2b-256 83681bd68680ae5beecac810066cd22e43e8836ac5cf4b7c615520f0046cd484

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