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

Uploaded Source

Built Distribution

youtrack_sdk-1.0.202404221301-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtrack_sdk-1.0.202404221301.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.12 Linux/6.5.0-1018-azure

File hashes

Hashes for youtrack_sdk-1.0.202404221301.tar.gz
Algorithm Hash digest
SHA256 a2698aa6f5b858072cb57f76d8fd1e2642c31c96c994e91ffb5b51763f53875b
MD5 2158272a1d8b4175c2d820b75034ab02
BLAKE2b-256 c2bb8f7aee915a08b11c81c1595405bd0e8533bab4f7a2ad990623238dc33f05

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202404221301-py3-none-any.whl
Algorithm Hash digest
SHA256 47a4689e2499c7fb777becb1c1aab152b1a8412a2c21d1f20120b86e7e253cc6
MD5 146e3c0148f3dc807b385840b8978995
BLAKE2b-256 09f47ac5733933080aa45174317844f209cef05dae6dd2b32ae04c159f1a3700

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