Shirino/README.md
2023-06-01 17:39:46 +04:00

36 lines
1.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Shirino
## Что это?
Telegram-бот который выводит курс валюты используя DuckDuckGO и [CoinAPI](https://www.coinapi.io/).
https://t.me/Shirino_bot
## Хочу запустить
Получите токен бота в телеграме и токен CoinAPI.
Вставьте в файл `.env` в формате:
```
COINAPI_KEYS=["Токен от CoinAPI"]
TELEGRAM_TOKEN=Токен Telegram-бота
```
В .env файл ещё можно такие переменные добавить:
```
DEBUG=false или true, включает отладочные логи
TIMEOUT=таймаут для библиотеки requests, в секундах (2 по дефолту)
```
## Хочу сделать пулл-реквест
Ставьте pylint и mypy для статической проверки кода.
Конфиги уже есть в репозитории.
После проверок можете открывать PR.
## Почему энв для CoinAPI -- список?
Можно получить несколько ключей на разные почтовые ящики
и все ключи вписать в список:
```
COINAPI_KEYS=["первый", "второй", "и так далее"]
```
Если вдруг один из них будет заблокирован по рейтлимиту,
бот автоматически переключиться на следующий (token rotation).