monokeys

Клиент «Ключей» — маленьких умных функций, которые зовутся одним вызовом. Зависимостей нет: внутри только стандартная библиотека, один файл.

pip install monokeys

from monokeys import Keys

k = Keys()                      # ничего настраивать не надо
res = k.alive("@durov")

print(res.is_alive)             # True
print(res.title)                # Pavel Durov

Ключ доступа заводить не нужно

Мы сделали работу за вас: публичный ключ работает у всех, без счётчика и без срока. Клиент берёт его сам, поэтому Keys() работает сразу — ни регистрации, ни настройки.

from monokeys import Keys
print(Keys().alive.text("@durov"))   # и всё, больше ничего не нужно

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

KEYS_API_KEY=kx_...

Отозвать свой ключ, если он утёк:

curl -X POST -H "Authorization: Bearer kx_..." https://АДРЕС/token/revoke

Три способа позвать ключ

k.alive("@durov")                    # весь ответ: объект с полями
k.alive.members_count("@durov")      # только одно поле, уже числом
k.alive.text("@durov")               # строка для человека

жив · channel · Pavel Durov · 11 005 185 subscribers

Аргументы

Keys(...) — подключение

k = Keys(token="kx_...", base="https://АДРЕС", timeout=5, retries=2)

k.<ключ>(...) — вызов

k.alive("@durov", only="members_count")   # 11005185
k.alive("@durov", fmt="bool")             # 'true'
k.alive("@durov", timeout=3)              # не ждать дольше трёх секунд

Что можно спросить у клиента

Ответ

Answer — это словарь, который умеет отвечать и как объект:

res = k.alive("@durov")
res.title == res["title"]     # одно и то же
bool(res)                     # True, если ключ ответил утвердительно
dict(res)                     # обычный словарь

Опечатка в имени поля не молчит:

res.tittle
# AttributeError: в ответе нет поля 'tittle'; есть: username, url, is_alive, ...

k.alive.members_cout("@durov")
# AttributeError: у ключа 'alive' нет поля 'members_cout'; есть: is_alive, kind, ...

Ошибки

У всех трёх есть .status (код ответа) и .body (что сказал сервер). AccessDenied и Unavailable — потомки KeysError, так что можно ловить одним except KeysError.

from monokeys import Keys, AccessDenied, Unavailable

try:
    res = k.alive("@durov")
except AccessDenied:
    print("ключ доступа не подошёл — попросите новый у владельца")
except Unavailable:
    print("сейчас занято, попробую позже")

Методы не зашиты в клиент

Список ключей и их полей приходит с сервера. Появился новый ключ — он доступен сразу, без обновления пакета:

k.names()          # ['alive', ...]
k.несуществующий   # AttributeError со списком существующих

Если ставить пакет не хочется

Тот же самый файл можно просто скачать — это буквально один исходник, из которого собран пакет:

curl https://АДРЕС/sdk/python > monokeys.py

А можно вообще без клиента — ключ это обычная ссылка:

https://АДРЕС/alive/@durov  ->  жив · channel · Pavel Durov · ...