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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtrack_sdk-1.0.202311200819.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.202311200819.tar.gz
Algorithm Hash digest
SHA256 ff8ef088b2cbe26e3070bc75078a2104f3b09f98907a5b4632625b071ea456e4
MD5 c35df8a46e6e95945ba8711263ac9cba
BLAKE2b-256 5c8118e8ebb7607d6b023223531af00456bf3ecf9c7f1519da405dade924ea89

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202311200819-py3-none-any.whl
Algorithm Hash digest
SHA256 df2875a220110fa20833026cc77d6ce1e5c2454dcb6129d357d739ba6e656e82
MD5 fb2a49c61a7fe9cf5420a0b4038fd0ed
BLAKE2b-256 131399669c1a6c2b1b2a57f4b868633c4fab3ca5dfe2e67a83b9b11ffff263f2

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