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

Uploaded Source

Built Distribution

youtrack_sdk-1.0.202409111140-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtrack_sdk-1.0.202409111140.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for youtrack_sdk-1.0.202409111140.tar.gz
Algorithm Hash digest
SHA256 f4957f156c5064c523d9391f672e3f936f45d5c1c7d76c8c8c98dfbd656da179
MD5 fef89763368b59a897c2b169550486ff
BLAKE2b-256 d0e8eafeffb0e25958032983b352d03178f3915ac21481590342da678d12b167

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202409111140-py3-none-any.whl
Algorithm Hash digest
SHA256 0325dfc3851e7f3339db53061d9fe085c0d7da5bc344c63351ffcf3ca7ef35c0
MD5 0a4642c18c660a20521fd18b6fd66bbc
BLAKE2b-256 60a8981267afcb883db412fd7bef1affbf6f0ee0160057dcbf6b82e7670a3315

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