# YouTrack REST API Client
A client library for accessing YouTrack REST API.
## Usage
```python
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/moneymeets/youtrack-sdk",
"name": "youtrack-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.12",
"maintainer_email": null,
"keywords": "youtrack, sdk",
"author": "moneymeets",
"author_email": "service@moneymeets.com",
"download_url": "https://files.pythonhosted.org/packages/ec/94/26b5979d935be6e34be844a6eb09254ac2894a304239dc30971816fa3f9c/youtrack_sdk-1.0.202410080802.tar.gz",
"platform": null,
"description": "# YouTrack REST API Client\n\nA client library for accessing YouTrack REST API.\n\n## Usage\n\n```python\nfrom datetime import date\nfrom youtrack_sdk import Client\nfrom youtrack_sdk.entities import (\n DateIssueCustomField,\n EnumBundleElement,\n Issue,\n Tag,\n Project,\n SingleEnumIssueCustomField,\n SingleUserIssueCustomField,\n StateBundleElement,\n StateIssueCustomField,\n User,\n)\n\nclient = Client(base_url=\"https://dummy.myjetbrains.com/youtrack\", token=\"dummy\")\nresult = client.create_issue(\n issue=Issue(\n project=Project(id=\"0-0\"),\n summary=\"Created from YouTrack SDK\",\n description=\"Description **text**.\",\n tags=[\n Tag(id=\"6-0\"),\n ],\n custom_fields=[\n StateIssueCustomField(\n name=\"State\",\n value=StateBundleElement(\n name=\"In Progress\",\n ),\n ),\n SingleUserIssueCustomField(\n name=\"Assignee\",\n value=User(\n ring_id=\"00000000-a31c-4174-bb27-abd3387df67a\",\n ),\n ),\n SingleEnumIssueCustomField(\n name=\"Type\",\n value=EnumBundleElement(\n name=\"Bug\",\n ),\n ),\n DateIssueCustomField(\n name=\"Due Date\",\n value=date(2005, 12, 31),\n ),\n ],\n ),\n)\n```\n\n## Note\n\n- 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.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "YouTrack SDK",
"version": "1.0.202410080802",
"project_urls": {
"Homepage": "https://github.com/moneymeets/youtrack-sdk",
"Repository": "https://github.com/moneymeets/youtrack-sdk"
},
"split_keywords": [
"youtrack",
" sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ff856ad603b26110abbff37faa84899dae2c647f4a9a0c9f36d2ed3ce1617905",
"md5": "cbd1c932f69e8d3749cb1b4204c304c6",
"sha256": "686200ce9ab28fe74975193b265f36a43c84f365d007e01d4436dc5ab79c67a7"
},
"downloads": -1,
"filename": "youtrack_sdk-1.0.202410080802-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cbd1c932f69e8d3749cb1b4204c304c6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.12",
"size": 11759,
"upload_time": "2024-10-08T08:02:17",
"upload_time_iso_8601": "2024-10-08T08:02:17.820773Z",
"url": "https://files.pythonhosted.org/packages/ff/85/6ad603b26110abbff37faa84899dae2c647f4a9a0c9f36d2ed3ce1617905/youtrack_sdk-1.0.202410080802-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ec9426b5979d935be6e34be844a6eb09254ac2894a304239dc30971816fa3f9c",
"md5": "d86a2b3e85201028198747d3c5c138f7",
"sha256": "08de70abf3f53fdfd702d00514b0cb10a5dc9c0ec2e86b45d771a4d22e45c7a7"
},
"downloads": -1,
"filename": "youtrack_sdk-1.0.202410080802.tar.gz",
"has_sig": false,
"md5_digest": "d86a2b3e85201028198747d3c5c138f7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.12",
"size": 10636,
"upload_time": "2024-10-08T08:02:18",
"upload_time_iso_8601": "2024-10-08T08:02:18.808824Z",
"url": "https://files.pythonhosted.org/packages/ec/94/26b5979d935be6e34be844a6eb09254ac2894a304239dc30971816fa3f9c/youtrack_sdk-1.0.202410080802.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-08 08:02:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "moneymeets",
"github_project": "youtrack-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "youtrack-sdk"
}
JSON
