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

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtrack_sdk-1.0.202509091024.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.202509091024.tar.gz
Algorithm Hash digest
SHA256 9d287c012a420b7564c1e89dcd8e3803c04bbe383491791a9c4f331114e90e31
MD5 b2597321c48409a8421d1e0992d4f6b4
BLAKE2b-256 f65026544865f0f3d01998b889742848aaf8ce999183434a92a3745365624b47

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202509091024-py3-none-any.whl
Algorithm Hash digest
SHA256 d58a062a9ee6e0ebbb2e42842b38e418c6ef2aa86277cfce10bde2fa4c27231a
MD5 746906417eec9481ba8d49e32b3b10b5
BLAKE2b-256 28dffed4605cf802b8e738012a497f3793956a2451440123dbc3dcd4844b33f0

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