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

Uploaded Source

Built Distribution

youtrack_sdk-1.0.202405170950-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtrack_sdk-1.0.202405170950.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-1021-azure

File hashes

Hashes for youtrack_sdk-1.0.202405170950.tar.gz
Algorithm Hash digest
SHA256 95618c987faeffe21ea56668687dff3ebe55f1b2116c75ddf759e3bb46ce6484
MD5 45d5f7a75983f51884e241f36fb4d02e
BLAKE2b-256 0948d5a92321ce6b16aee7883dff0b62714499ed4585d1db056e580f1793f3f5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202405170950-py3-none-any.whl
Algorithm Hash digest
SHA256 6e742bcf52ba2fe48a238307fddac60b36e817e75228d2e727af9b133965a2a5
MD5 9b08cc8363b9fe62d7d3ab76a65982a7
BLAKE2b-256 9d62ca22da8acbef7b04022603eb99a5df532d6c329b6d5766c1dcbaee16a211

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