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.202410080802.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

youtrack_sdk-1.0.202410080802-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtrack_sdk-1.0.202410080802.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.8.0-1014-azure

File hashes

Hashes for youtrack_sdk-1.0.202410080802.tar.gz
Algorithm Hash digest
SHA256 08de70abf3f53fdfd702d00514b0cb10a5dc9c0ec2e86b45d771a4d22e45c7a7
MD5 d86a2b3e85201028198747d3c5c138f7
BLAKE2b-256 ec9426b5979d935be6e34be844a6eb09254ac2894a304239dc30971816fa3f9c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202410080802-py3-none-any.whl
Algorithm Hash digest
SHA256 686200ce9ab28fe74975193b265f36a43c84f365d007e01d4436dc5ab79c67a7
MD5 cbd1c932f69e8d3749cb1b4204c304c6
BLAKE2b-256 ff856ad603b26110abbff37faa84899dae2c647f4a9a0c9f36d2ed3ce1617905

See more details on using hashes here.

Supported by

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