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

Uploaded Source

Built Distribution

youtrack_sdk-1.0.202311081310-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtrack_sdk-1.0.202311081310.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.12 Linux/6.2.0-1015-azure

File hashes

Hashes for youtrack_sdk-1.0.202311081310.tar.gz
Algorithm Hash digest
SHA256 77165f10361c05b4f38792b0e9ad66581855454e002353ccdd4115ff609adac4
MD5 0f223b3a5067134aac9fe14cb662ab75
BLAKE2b-256 95b0b7fdbbd9c9b113f851c409dad9f8f38dc7c08e6aca773ae11bad0b99e53c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202311081310-py3-none-any.whl
Algorithm Hash digest
SHA256 5bbb39546ad1efa2d54e468b82859747f02d8628e10420fc6567a337f6dcb680
MD5 a3b595e41db702a241287332e27a817b
BLAKE2b-256 02a9ce7f5264c0294fa9e83283a68baae05f73d9df752e4190110107ce5bee0c

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