Skip to content

Commit

Permalink
doc: add basic usage example and installation guide to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
danfimov committed Sep 30, 2023
1 parent b7be166 commit e82fddb
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,59 @@ Async Yandex Tracker Client based on aiohttp and pydantic (v2)
[![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)
[![Linters](https://github.com/danfimov/ya_tracker_client/actions/workflows/code-check.yml/badge.svg)](https://github.com/danfimov/ya_tracker_client/actions/workflows/code-check.yml)

---

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

## Installation

```shell
pip install ya_tracker_clint
```

## Usage

```python
import os
from asyncio import run

from dotenv import load_dotenv

from ya_tracker_client import YaTrackerClient


load_dotenv()
# from registered application at Yandex OAuth - https://oauth.yandex.ru/
API_TOKEN = os.getenv("API_TOKEN")
# from admin panel at Yandex Tracker - https://tracker.yandex.ru/admin/orgs
API_ORGANISATION_ID = os.getenv("API_ORGANISATION_ID")


async def main() -> None:
# init client
client = YaTrackerClient(
organisation_id=API_ORGANISATION_ID,
oauth_token=API_TOKEN,
)

# create issue
new_issue = await client.create_issue('New issue', 'TRACKER-QUEUE')

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

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

# don't forget to close tracker on app shutdown
await client.stop()


if __name__ == "__main__":
run(main())
```


## Explanations about naming

- All `self` properties renamed to `url` cause it's incompatible with Python;
Expand Down

0 comments on commit e82fddb

Please sign in to comment.