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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtrack_sdk-1.0.202311081040.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.202311081040.tar.gz
Algorithm Hash digest
SHA256 73979ac45a200b12b3d6d64490160f24a0cca697ed62e76e56658a7c550817c6
MD5 edf4f0711504f5ace995970620771443
BLAKE2b-256 9974154b00813b0845c546643bf98d6845e3955ad9187051d8e0fea6be51a34d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202311081040-py3-none-any.whl
Algorithm Hash digest
SHA256 c6fc01386011b8378bd9862cf24da1676dc4cab88364b16cf59409a0e4e848b2
MD5 3dee972068b3e3bfc20dcf6094ff053d
BLAKE2b-256 486917b789d4812c96735c6c21f1212f5ced5f6018f4803c212134cc8760590c

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