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

Uploaded Source

Built Distribution

youtrack_sdk-1.0.202402121023-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for youtrack_sdk-1.0.202402121023.tar.gz
Algorithm Hash digest
SHA256 8c0f5585987becf3e009d1e8748111776eae9b58b82006d65af98c015dac4534
MD5 54ec9a559b570137e955d4d66fc75b2d
BLAKE2b-256 07e558058bada9209fe371feb75ca2bb2c92763ddb6eb370ce131fead730c5f8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202402121023-py3-none-any.whl
Algorithm Hash digest
SHA256 047063f8ba02b8a8c4c5b790b2fdaa557b4e796b4efc1e8ab2ec7d2669f5915c
MD5 e96fc417cb4ad973d3263306316ca0bf
BLAKE2b-256 6c46b67da7609b8888bca9ad4901464e324a5bd994f99a1593833a8f7abb4fa8

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