From fe6847330bd5bf8ebcd4e395d723fbc311ed07fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=94=D0=BC=D0=B8=D1=82=D1=80=D0=B8=D0=B9=20=D0=90=D0=BD?= =?UTF-8?q?=D1=84=D0=B8=D0=BC=D0=BE=D0=B2?= Date: Sat, 30 Sep 2023 21:05:35 +0300 Subject: [PATCH] feat: prittier README.md with badges --- .github/workflows/code-check.yml | 2 +- README.md | 13 ++++++++++++- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/.github/workflows/code-check.yml b/.github/workflows/code-check.yml index a309e50..ef0cc57 100644 --- a/.github/workflows/code-check.yml +++ b/.github/workflows/code-check.yml @@ -1,4 +1,4 @@ -name: Checks +name: Linters and tests on: [pull_request] jobs: diff --git a/README.md b/README.md index 7399c44..c084550 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,18 @@ Async Yandex Tracker Client based on aiohttp and pydantic (v2) -# Current library capabilities +[![Python](https://img.shields.io/badge/python-^3.11-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) +[![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) + +## Explanations about naming + +- 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. + +## Current library capabilities - Working with queues - Getting information about issues, priorities and transitions