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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtrack_sdk-1.0.202408050654.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-1025-azure

File hashes

Hashes for youtrack_sdk-1.0.202408050654.tar.gz
Algorithm Hash digest
SHA256 490fd522f68fd2e7f5d35d5f4b046837816fbf481b43f7b5fcb5a2f963c2c451
MD5 f692c2a40b33f123d753bdfe99445e2d
BLAKE2b-256 35da34844a5be661dcba1c4d152653c914ba36aa8f1b642de766dff422bfdeb0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202408050654-py3-none-any.whl
Algorithm Hash digest
SHA256 a91a1ff23929a6dee14eaf980c51a14d0011a05eed29109f84530d6959c16e39
MD5 3af80abfbd922d006e26bf183cf09309
BLAKE2b-256 3c6f47dcdb5002da2f8aeeae9fa8a5b29b5af887f82826fe594bca54251b366c

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