youtrack-python 0.1.1__tar.gz

youtrack_python-0.1.1/.coveragerc

@@ -0,0 +1,9 @@
+[run]
+branch = True
+relative_files = True
+
+[report]
+omit = tests/*
+show_missing = True
+skip_covered = False
+precision = 2

youtrack_python-0.1.1/.github/workflows/lint-and-test.yml

@@ -0,0 +1,68 @@
+name: Lint and Test (ruff + pyright + pytest)
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  lint-and-test:
+    name: Lint and Test
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: |
+            **/pyproject.toml
+            **/uv.lock
+
+      - name: Show uv version
+        run: uv --version
+
+      - name: Sync dependencies (frozen)
+        run: uv sync --frozen
+
+      - name: Check formatting (ruff)
+        run: uv run ruff format --check
+
+      - name: Lint (ruff)
+        run: uv run ruff check
+
+      - name: Static type checking
+        run: uv run pyright
+
+      - name: Tests with coverage (pytest-cov)
+        run: |
+          uv run \
+            pytest tests/ \
+              --cov=youtrack_sdk \
+              --cov-branch \
+              --cov-config="${{ github.workspace }}/.coveragerc" \
+              --cov-report=term-missing:skip-covered \
+              --cov-report=xml:coverage.xml \
+              --cov-report=html:coverage_html \
+              --cov-fail-under=85
+
+      - name: Add coverage summary
+        run: |
+          python3 - <<'PY' | tee -a "$GITHUB_STEP_SUMMARY"
+          import xml.etree.ElementTree as ET
+          r = float(ET.parse('coverage.xml').getroot().get('branch-rate'))*100
+          print(f"coverage: {r:.2f}%")
+          PY
+
+      - name: Upload coverage artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-reports
+          path: |
+            coverage.xml
+            coverage_html
+          if-no-files-found: ignore
+          retention-days: 14

youtrack_python-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,90 @@
+name: Release (build + publish to PyPI)
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  verify-version:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Check out tag
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.release.tag_name }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Verify tag matches pyproject.toml version
+        env:
+          TAG_NAME: ${{ github.event.release.tag_name }}
+        run: |
+          python - <<'PY'
+          import os, re, sys, pathlib, tomllib
+
+          tag = os.environ["TAG_NAME"]
+          m = re.fullmatch(r"v(\d+\.\d+\.\d+)", tag)
+          if not m:
+              print(f"ERROR: Release tag {tag!r} is not in vX.Y.Z format.")
+              sys.exit(1)
+
+          data = tomllib.loads(pathlib.Path("pyproject.toml").read_text("utf-8"))
+          version = data.get("project", {}).get("version")
+          if not version:
+              print("ERROR: Missing [project].version in pyproject.toml.")
+              sys.exit(1)
+
+          tag_version = m.group(1)
+          if version != tag_version:
+              print(f"ERROR: Version mismatch: pyproject.toml={version!r} tag={tag_version!r}")
+              sys.exit(1)
+
+          print(f"OK: {version} matches {tag}")
+          PY
+
+  build:
+    runs-on: ubuntu-latest
+    needs: [verify-version]
+    permissions:
+      contents: read
+    steps:
+      - name: Check out tag
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.release.tag_name }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Upload dist artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: [build]
+    environment:
+      name: pypi
+      url: https://pypi.org/p/youtrack-python
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Publish to PyPI (Trusted Publishing)
+        uses: pypa/gh-action-pypi-publish@release/v1

youtrack_python-0.1.1/.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+.pytest_cache/
+
+/.idea/*
+!/.idea/watcherTasks.xml
+.vscode/
+coverage_html/
+**/.coverage

youtrack_python-0.1.1/.idea/watcherTasks.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectTasksOptions">
+    <TaskOptions isEnabled="true">
+      <option name="arguments" value="sh -c &quot;$PyInterpreterDirectory$/ruff check --fix $FilePath$ ; $PyInterpreterDirectory$/ruff format $FilePath$ ; $PyInterpreterDirectory$/ruff check --fix $FilePath$ ; $PyInterpreterDirectory$/ruff format $FilePath$&quot;" />
+      <option name="checkSyntaxErrors" value="true" />
+      <option name="description" />
+      <option name="exitCodeBehavior" value="NEVER" />
+      <option name="fileExtension" value="py" />
+      <option name="immediateSync" value="false" />
+      <option name="name" value="ruff" />
+      <option name="output" value="$FilePath$" />
+      <option name="outputFilters">
+        <array />
+      </option>
+      <option name="outputFromStdout" value="false" />
+      <option name="program" value="env" />
+      <option name="runOnExternalChanges" value="true" />
+      <option name="scopeName" value="Project Files" />
+      <option name="trackOnlyRoot" value="false" />
+      <option name="workingDir" value="$ProjectFileDir$" />
+      <envs />
+    </TaskOptions>
+
+    <TaskOptions isEnabled="true">
+      <option name="arguments" value="-m json.tool --indent 2 --no-ensure-ascii $FilePath$ $FilePath$" />
+      <option name="checkSyntaxErrors" value="true" />
+      <option name="description" />
+      <option name="exitCodeBehavior" value="ERROR" />
+      <option name="fileExtension" value="json" />
+      <option name="immediateSync" value="false" />
+      <option name="name" value="JSON formatting" />
+      <option name="output" value="$FilePath$" />
+      <option name="outputFilters">
+        <array />
+      </option>
+      <option name="outputFromStdout" value="false" />
+      <option name="program" value="$PyInterpreterDirectory$/python" />
+      <option name="runOnExternalChanges" value="true" />
+      <option name="scopeName" value="All Changed Files" />
+      <option name="trackOnlyRoot" value="false" />
+      <option name="workingDir" value="$ProjectFileDir$" />
+      <envs />
+    </TaskOptions>
+  </component>
+</project>

youtrack_python-0.1.1/.run/Run Tests.run.xml

@@ -0,0 +1,21 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run Tests" type="tests" factoryName="py.test">
+    <module name="youtrack-sdk" />
+    <option name="ENV_FILES" value="" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="PARENT_ENVS" value="true" />
+    <option name="SDK_HOME" value="" />
+    <option name="WORKING_DIRECTORY" value="" />
+    <option name="IS_MODULE_SDK" value="true" />
+    <option name="ADD_CONTENT_ROOTS" value="true" />
+    <option name="ADD_SOURCE_ROOTS" value="true" />
+    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
+    <option name="RUN_TOOL" value="true" />
+    <option name="_new_keywords" value="&quot;&quot;" />
+    <option name="_new_parameters" value="&quot;&quot;" />
+    <option name="_new_additionalArguments" value="&quot;&quot;" />
+    <option name="_new_target" value="&quot;$PROJECT_DIR$/tests&quot;" />
+    <option name="_new_targetType" value="&quot;PATH&quot;" />
+    <method v="2" />
+  </configuration>
+</component>

youtrack_python-0.1.1/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023-2024 moneymeets GmbH
+Copyright (c) 2026 Ninjaneers GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

youtrack_python-0.1.1/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.4
+Name: youtrack-python
+Version: 0.1.1
+Summary: YouTrack SDK
+Project-URL: Repository, https://github.com/ninjaneers-team/youtrack-sdk
+Project-URL: Homepage, https://github.com/moneymeets/youtrack-sdk
+Author-email: moneymeets <service@moneymeets.com>, Michael Gerhold <michael.gerhold@ninjaneers.de>
+License: MIT License
+        
+        Copyright (c) 2023-2024 moneymeets GmbH
+        Copyright (c) 2026 Ninjaneers GmbH
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: sdk,youtrack
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.13
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2.12.5
+Description-Content-Type: text/markdown
+
+# YouTrack REST API Client
+
+A client library for accessing YouTrack REST API.
+
+This is a fork of [moneymeets/youtrack-sdk](https://github.com/moneymeets/youtrack-sdk) with several enhancements.
+
+## Key Changes from Original
+
+This fork includes the following improvements over the original repository:
+
+- **AsyncClient Implementation**: Full async/await support with `AsyncClient` for non-blocking I/O operations
+- **Project Custom Fields API**: New `get_project_custom_fields()` method to retrieve custom field definitions for projects
+- **Migrated to UV**: Switched from Poetry to UV for dependency management
+- **Enhanced Testing**: Migrated test suite from unittest to Pytest with async test support
+- **Modern Python**: Updated to require Python 3.13+ with improved type hints and linting
+- **Improved Code Quality**: Enhanced linting with Ruff and type checking with Pyright
+
+## Usage
+
+### Synchronous Client
+
+```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,
+)
+
+with Client(base_url="https://dummy.myjetbrains.com/youtrack", token="dummy") as client:
+    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),
+                ),
+            ],
+        ),
+    )
+```
+
+### Async Client
+
+```python
+import asyncio
+from youtrack_sdk import AsyncClient
+from youtrack_sdk.entities import Project
+
+async def main():
+    async with AsyncClient(base_url="https://dummy.myjetbrains.com/youtrack", token="dummy") as client:
+        projects = await client.get_projects()
+        for project in projects:
+            print(f"Project: {project.name}")
+
+asyncio.run(main())
+```
+
+### Fetching Project Custom Fields
+
+```python
+from youtrack_sdk import Client
+
+with Client(base_url="https://dummy.myjetbrains.com/youtrack", token="dummy") as client:
+    custom_fields = client.get_project_custom_fields(project_id="0-0")
+
+    for field in custom_fields:
+        print(f"Field: {field.field.name}, Type: {type(field).__name__}")
+```
+
+See [examples/list_project_custom_fields.py](examples/list_project_custom_fields.py) for a complete example.
+
+## 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.

youtrack_python-0.1.1/README.md

@@ -0,0 +1,107 @@
+# YouTrack REST API Client
+
+A client library for accessing YouTrack REST API.
+
+This is a fork of [moneymeets/youtrack-sdk](https://github.com/moneymeets/youtrack-sdk) with several enhancements.
+
+## Key Changes from Original
+
+This fork includes the following improvements over the original repository:
+
+- **AsyncClient Implementation**: Full async/await support with `AsyncClient` for non-blocking I/O operations
+- **Project Custom Fields API**: New `get_project_custom_fields()` method to retrieve custom field definitions for projects
+- **Migrated to UV**: Switched from Poetry to UV for dependency management
+- **Enhanced Testing**: Migrated test suite from unittest to Pytest with async test support
+- **Modern Python**: Updated to require Python 3.13+ with improved type hints and linting
+- **Improved Code Quality**: Enhanced linting with Ruff and type checking with Pyright
+
+## Usage
+
+### Synchronous Client
+
+```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,
+)
+
+with Client(base_url="https://dummy.myjetbrains.com/youtrack", token="dummy") as client:
+    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),
+                ),
+            ],
+        ),
+    )
+```
+
+### Async Client
+
+```python
+import asyncio
+from youtrack_sdk import AsyncClient
+from youtrack_sdk.entities import Project
+
+async def main():
+    async with AsyncClient(base_url="https://dummy.myjetbrains.com/youtrack", token="dummy") as client:
+        projects = await client.get_projects()
+        for project in projects:
+            print(f"Project: {project.name}")
+
+asyncio.run(main())
+```
+
+### Fetching Project Custom Fields
+
+```python
+from youtrack_sdk import Client
+
+with Client(base_url="https://dummy.myjetbrains.com/youtrack", token="dummy") as client:
+    custom_fields = client.get_project_custom_fields(project_id="0-0")
+
+    for field in custom_fields:
+        print(f"Field: {field.field.name}, Type: {type(field).__name__}")
+```
+
+See [examples/list_project_custom_fields.py](examples/list_project_custom_fields.py) for a complete example.
+
+## 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.