Shirino/README.md

42 lines
1.4 KiB
Markdown

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