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

Uploaded Source

Built Distribution

youtrack_sdk-1.0.202311030834-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtrack_sdk-1.0.202311030834.tar.gz
  • Upload date:
  • Size: 9.2 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.202311030834.tar.gz
Algorithm Hash digest
SHA256 4f309c2caaf4f20fc77fd080ffd6b57537490537f2785df8867ea89a7a49cb40
MD5 84384fe7bd62716d8dde143848240761
BLAKE2b-256 331b37ccf3b09c16c73acb11dc5a617b8e087d6f8d8ed9be0e161068036b8bbc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202311030834-py3-none-any.whl
Algorithm Hash digest
SHA256 8a2269dd05c209f99e219f8a6a36350a772905f17b2f544283926a3ef1808778
MD5 c65fe398ebfe127c70ad4daf299235a7
BLAKE2b-256 e35898014327e619e68647e8b2710f0e07105d00e3dd279695e8f8e950267cf6

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