Async Yandex Tracker Client
Project description
Yandex Tracker Client (or Yet Another Tracker Client)
Async Yandex Tracker Client based on aiohttp and pydantic
API docs: https://cloud.yandex.com/en/docs/tracker/about-api
Installation
pip install ya_tracker_client
or
poetry add ya_tracker_client
Usage
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 tourl
cause it's incompatible with Python; - All
camelCase
properties renamed topythonic_case
; - All datetime values converted to python's
datetime.datetime
objects; - Methods named by author, cause Yandex API has no clear method names.
Current library capabilities
- Working with queues
- Getting information about issues, priorities and transitions
- Working with issue relationships
- Getting user information
More info about work status here: https://github.com/danfimov/ya_tracker_client/milestone/1
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ya_tracker_client-0.0.2.tar.gz
(19.9 kB
view hashes)
Built Distribution
Close
Hashes for ya_tracker_client-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57bf9adc4227aabc4a22feb1b7fb0e3851a05a282a1f90e59d78f27527b4b66d |
|
MD5 | bda7d9f65f032156b42ad546700d2609 |
|
BLAKE2b-256 | 3ea6162e81c1be99e035778c20248783c0a63978760074f2a6a38e40d3e81a2a |