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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtrack_sdk-1.0.202311200940.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.202311200940.tar.gz
Algorithm Hash digest
SHA256 3b2da45c7f86aad7db096df80c76cad40c91e28bc1f0949375482f692334b462
MD5 14fc7a9609f8532d31596412af044d43
BLAKE2b-256 c3cd8961fe053a0c7d83f8fa7204ef98a339f5a547e180ec464e8f2a15cdba23

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202311200940-py3-none-any.whl
Algorithm Hash digest
SHA256 ffb6c30a3230ae50d6e44d4273193e0d34baee25897929eea3c18b9a1237b52b
MD5 6751550a74252f3a1938f94fdb54f9fc
BLAKE2b-256 bfdb1f20e955c81e170b0cd4c0731c4365e3e96bb9c0af0f4e8af371b227a9d5

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