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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtrack_sdk-1.0.202312061131.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-1016-azure

File hashes

Hashes for youtrack_sdk-1.0.202312061131.tar.gz
Algorithm Hash digest
SHA256 88892e43a063a549eca48b66d7b3a2bad920803723ea36fe3c9eccc62f1d2ce2
MD5 b2d166ab5b6ee6beaf51b961de6ca19c
BLAKE2b-256 ced2778b5d07ca1b37de92f861f04f92beca18533d87613b9b45be45ea83460f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202312061131-py3-none-any.whl
Algorithm Hash digest
SHA256 a3f0c8f4502696f40f62aed1b7c3e43436ae41cae36ed35566074e022dc1c9ce
MD5 0dc1c59ed37eb74349df4a26ab417daa
BLAKE2b-256 bf63366e696083af52f0d9c1bc2594b45acd37df7789a43015f182459c821eb6

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