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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtrack_sdk-1.0.202402091306.tar.gz
  • Upload date:
  • Size: 9.7 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.202402091306.tar.gz
Algorithm Hash digest
SHA256 50c8a98405470149b56cd337050abe09f53591c8a136d578693096237cfefaef
MD5 0b843670a8f3371e36e3bb638c432e52
BLAKE2b-256 aaef138497282f2d7a90a2e915b6b11951aad8409e653e9e7896e8ca27851e1a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202402091306-py3-none-any.whl
Algorithm Hash digest
SHA256 95fd7997384fc28ae627e00c251ff8b948b7956dcdbbc2c9f021afe669b19425
MD5 8ef3e8546fb9849f903b9b93e7211546
BLAKE2b-256 19732864b1237cf0cb2f88b0e774ba724882b29005aca1e83d09866ad365859a

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