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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtrack_sdk-1.0.202312110736.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-1018-azure

File hashes

Hashes for youtrack_sdk-1.0.202312110736.tar.gz
Algorithm Hash digest
SHA256 5957b8231af62b726307dbb9eb90aa6c647aa7cf119fed38160278077b1b7d24
MD5 cc1c224ed081e20fa3d613cdc913f2fa
BLAKE2b-256 86927233450073be7e4c5c740c4bae46145a4337d081c5581d231e6347d20b25

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202312110736-py3-none-any.whl
Algorithm Hash digest
SHA256 6b1297805df5a478910da3628272f18f3ed4ba14accfb65e72813281363caf64
MD5 dcff62205ed8a1e4db3f4371d9596149
BLAKE2b-256 6ee328b0a556900be3cbe8240eba39d0f6985b2109bb74b0c3fb10fe4f3edeeb

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