shiki4py 2.1.0

Asynchronous client for api Shikimori written in Python 3.7 with asyncio and aiohttp.

Асинхронный клиент для взаимодействия с api Shikimori, написанный на Python 3.7 c использованием asyncio и aiohttp.

Версии shiki4py v0.2.2 и раньше являются синхронными, но начиная с v2.0.0 этот пакет стал асинхронным. Рекомендую использовать в своих проектах только shiki4py >= v2.0.0!

Сравнение shiki4py v0.2.2 и v2.0.0 по времени отправки 25 запросов:

shiki4py v0.2.2 ~10.5 секунд

Код

from shiki4py import Client


client = Client("APP_NAME",
                "CLIENT_ID",
                "CLIENT_SECRET")
for i in range(25):
    client.get(f"/users/{i}/info")

shiki4py v2.0.0 ~5.07 секунд

Код

from shiki4py import Shikimori
import asyncio


async def main():
    async with Shikimori("APP_NAME", "CLIENT_ID", "CLIENT_SECRET") as api:
        await asyncio.gather(*[api.users.info(i) for i in range(25)])


asyncio.run(main())

Особенности

• Поддержка api v1 и v2
• Ограничения 5rps и 90rpm
• OAuth2 авторизация
• Контроль срока действия токена
• Хранение токенов в .env файле
• Свой класс с методами для каждого ресурса api (пока только для comments и users)
• Представление json данных как python классы

Установка

pip install shiki4py

Использование

Быстрый старт

from shiki4py import Shikimori
import asyncio
import logging


logging.basicConfig(level=logging.INFO)


async def main():
    # Клиент без авторизации
    async with Shikimori("APP_NAME") as api:
        clubs = await api.users.clubs(555400)
        print(clubs)

    # Клиент с авторизацией
    api = Shikimori("APP_NAME",
                    "CLIENT_ID",
                    "CLIENT_SECRET")
    await api.open()
    # Отправляем запросы
    # await api.client.request(...)
    # await api.users.favourites(...)
    # await api.comments.show_one(...)
    # ...
    await api.close()


asyncio.run(main())

Сохранение токенов авторизации

По умолчанию клиент сохраняет токены авторизации в файле .env, но при инициализации можно выбрать другой вариант хранения токенов, либо создать свой вариант унаследовав базовый класс и переопределив его методы.

from shiki4py import Shikimori
from shiki4py.store import BaseTokenStore
from shiki4py.store.memory import MemoryTokenStore


class MyTokenStore(BaseTokenStore):
    ...


api = Shikimori("APP_NAME",
                "CLIENT_ID",
                "CLIENT_SECRET",
                # store=MyTokenStore()
                store=MemoryTokenStore())

Зависимости

• aiohttp - для асинхронных http запросов
• PyrateLimiter - для ограничения частоты запросов
• attrs - для преобразования данных json в python классы
• cattrs - дополнение к attrs для структурирования и деструктурирования данных
• python-dotenv - для сохранения токенов авторизации в .env файл