yatracker


Nameyatracker JSON
Version 2024.4.2 PyPI version JSON
download
home_pageNone
SummaryAsync client for Yandex Tracker API
upload_time2024-04-22 19:44:13
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords api tracker yandex async
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            YaTracker
===

Asyncio Yandex Tracker API client

[![Python](https://img.shields.io/badge/python-^3.10-blue)](https://www.python.org/)
[![Code linter: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)
[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
[![Linters](https://github.com/Olegt0rr/YaTracker/actions/workflows/linters.yml/badge.svg)](https://github.com/Olegt0rr/YaTracker/actions/workflows/linters.yml)
---

Documentation: https://olegt0rr.github.io/YaTracker/

API docs: https://cloud.yandex.com/en/docs/tracker/about-api

## Attention!
* All `self` properties renamed to `url` cause it's incompatible with Python.
* All `camelCase` properties renamed to `pythonic_case`.
* All datetime values converted to python's `datetime.datetime` objects.
* Methods named by author, cause Yandex API has no clear method names.


## How to install
```text
pip install yatracker
```


## How to use
```python
from yatracker import YaTracker

tracker = YaTracker(org_id=..., token=...)

async def foo():
    # create issue
    issue = await tracker.create_issue('New Issue', 'KEY')

    # get issue
    issue = await tracker.get_issue('KEY-1')

    # update issue (just pass kwargs)
    issue = await tracker.edit_issue('KEY-1', description='Hello World')

    # get transitions:
    transitions = await issue.get_transitions()

    # execute transition
    transition = transitions[0]
    await transition.execute()

```
```python
# don't forget to close tracker on app shutdown
async def on_shutdown():
    await tracker.close()

```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "yatracker",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "Oleg Abramov <oleg@trueweb.app>",
    "keywords": "API, Tracker, Yandex, async",
    "author": null,
    "author_email": "Oleg Abramov <oleg@trueweb.app>",
    "download_url": "https://files.pythonhosted.org/packages/95/b9/08a247a3be046bdd4d9dfe2581d65c20963a232fc4ddf0aaccb0c5562791/yatracker-2024.4.2.tar.gz",
    "platform": null,
    "description": "YaTracker\n===\n\nAsyncio Yandex Tracker API client\n\n[![Python](https://img.shields.io/badge/python-^3.10-blue)](https://www.python.org/)\n[![Code linter: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)\n[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)\n[![Linters](https://github.com/Olegt0rr/YaTracker/actions/workflows/linters.yml/badge.svg)](https://github.com/Olegt0rr/YaTracker/actions/workflows/linters.yml)\n---\n\nDocumentation: https://olegt0rr.github.io/YaTracker/\n\nAPI docs: https://cloud.yandex.com/en/docs/tracker/about-api\n\n## Attention!\n* All `self` properties renamed to `url` cause it's incompatible with Python.\n* All `camelCase` properties renamed to `pythonic_case`.\n* All datetime values converted to python's `datetime.datetime` objects.\n* Methods named by author, cause Yandex API has no clear method names.\n\n\n## How to install\n```text\npip install yatracker\n```\n\n\n## How to use\n```python\nfrom yatracker import YaTracker\n\ntracker = YaTracker(org_id=..., token=...)\n\nasync def foo():\n    # create issue\n    issue = await tracker.create_issue('New Issue', 'KEY')\n\n    # get issue\n    issue = await tracker.get_issue('KEY-1')\n\n    # update issue (just pass kwargs)\n    issue = await tracker.edit_issue('KEY-1', description='Hello World')\n\n    # get transitions:\n    transitions = await issue.get_transitions()\n\n    # execute transition\n    transition = transitions[0]\n    await transition.execute()\n\n```\n```python\n# don't forget to close tracker on app shutdown\nasync def on_shutdown():\n    await tracker.close()\n\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Async client for Yandex Tracker API",
    "version": "2024.4.2",
    "project_urls": {
        "Documentation": "https://olegt0rr.github.io/YaTracker/",
        "Repository": "https://github.com/Olegt0rr/YaTracker/"
    },
    "split_keywords": [
        "api",
        " tracker",
        " yandex",
        " async"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2b289bf9c5f098f64d9de0240bec0a8812f1846d83a3a8605570c678fc1a30c8",
                "md5": "a1c4594fc67e19f41c6bc3763eceb969",
                "sha256": "fcbd606ee7b1b29368e48e0229985014c58a62e8655ba4582e373be5e8725054"
            },
            "downloads": -1,
            "filename": "yatracker-2024.4.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a1c4594fc67e19f41c6bc3763eceb969",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 30334,
            "upload_time": "2024-04-22T19:44:11",
            "upload_time_iso_8601": "2024-04-22T19:44:11.603904Z",
            "url": "https://files.pythonhosted.org/packages/2b/28/9bf9c5f098f64d9de0240bec0a8812f1846d83a3a8605570c678fc1a30c8/yatracker-2024.4.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "95b908a247a3be046bdd4d9dfe2581d65c20963a232fc4ddf0aaccb0c5562791",
                "md5": "5888f0470af87536c152efcd81f78001",
                "sha256": "637167420f11346cf60cc6c66823d70dc832fca939a6e48aa7ae42e13aab9d95"
            },
            "downloads": -1,
            "filename": "yatracker-2024.4.2.tar.gz",
            "has_sig": false,
            "md5_digest": "5888f0470af87536c152efcd81f78001",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 22307,
            "upload_time": "2024-04-22T19:44:13",
            "upload_time_iso_8601": "2024-04-22T19:44:13.323377Z",
            "url": "https://files.pythonhosted.org/packages/95/b9/08a247a3be046bdd4d9dfe2581d65c20963a232fc4ddf0aaccb0c5562791/yatracker-2024.4.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-22 19:44:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Olegt0rr",
    "github_project": "YaTracker",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "yatracker"
}
        
Elapsed time: 0.35455s