olegt0rr/yatracker

Asyncio Yandex Tracker API client

YaTracker

Asyncio Yandex Tracker API client

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

pip install yatracker

How to use

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()

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

yatracker's Issues

Add attachments

Comments support

• add comment
• get comments
• edit comment
• delete comment

Checklists support

• add item
• get items
• edit item
• delete item
• delete checklist

Use datetime objects instead of str

Replace text fields with python datetime.datetime objects

Queues support

Macros support

Custom Issue fields support

I have some custom fields in Issue and should use it via model.
We should make ability to pass arguments with custom Issue class to fill it with data from API

Import support

• import issues
• import attachments
• import comments
• import links

Applications support

Prevent duplicated GitHub Actions

Change field `encode_name` inspection

          `msgspec.inspect.type_info` is one way, but it's a bit overkill for this use case. And `__struct_encode_fields__` is technically non-public (and may be removed in the future). The best way to get this information is to use `msgspec.struct.fields` ([docs](https://jcristharif.com/msgspec/api.html#msgspec.structs.fields)). You're looking for the `encode_name` attribute on `FieldInfo` in the result:

In [3]: class Example(msgspec.Struct):
   ...:     user_id: int = msgspec.field(name="userId")
   ...: 

In [4]: msgspec.structs.fields(Example)
Out[4]: (FieldInfo(name='user_id', encode_name='userId', type=<class 'int'>, default=NODEFAULT, default_factory=NODEFAULT),)

Originally posted by @jcrist in jcrist/msgspec#672 (comment)

Projects support

Worklog support

• add worklog
• edit worklog
• delete worklog
• get issue worklog
• search worklog

Cloud org support

Transition execute wrong url

Tansition uses self url + _execute postfix.
Client also adds version prefix.

Requested url:

/v2https://api.tracker.yandex.net/v2/issues/TEST-1/transitions/start_progress/_execute was not found

Components support

• get components

Add tracker object link to produced objects

Boards support

Add docs

Bulk change support