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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: youtrack_sdk-1.0.202410010913.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.8.0-1014-azure

File hashes

Hashes for youtrack_sdk-1.0.202410010913.tar.gz
Algorithm Hash digest
SHA256 3c0cb65f90a1d26c9d1a4c2b7bfb70fc3181b860dd06327e8b3f2f0a9741687f
MD5 6f6325896c76324eb12cb1903a067232
BLAKE2b-256 e21b04a059128068c0fca55f754eb90405ac837ad43319cf1e666929b195fcde

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for youtrack_sdk-1.0.202410010913-py3-none-any.whl
Algorithm Hash digest
SHA256 74de2b4f4aa0a74c32abd029d1e820d2104ab06876342eef7ca2a3540fb869b4
MD5 6e9ccb0a0714a63e5dde74e0d1de1dfe
BLAKE2b-256 f45eeb19ef47b6932675edf97ab436ba8b7c980c17f3c627570b7ec180190db2

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