Shirino/README.md

51 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

2023-05-30 13:59:36 +03:00
# Shirino
2024-09-30 14:07:50 +03:00
> [!NOTE]
> Telegram-бот который выводит курс валюты используя DuckDuckGO и [CoinAPI](https://www.coinapi.io/).
>
> https://t.me/shirino_bot
2023-05-30 13:59:36 +03:00
## Хочу запустить
2024-09-30 14:07:50 +03:00
<details>
2023-05-30 13:59:36 +03:00
Получите токен бота в телеграме и токен CoinAPI.
2024-09-30 14:07:50 +03:00
Вставьте в файл `config.yaml` в формате:
2023-05-30 14:18:23 +03:00
```yaml
coinapi_keys:
- key1
- key2
- etc.
telegram_token: Токен Telegram-бота
2023-05-30 13:59:36 +03:00
```
2024-09-30 14:07:50 +03:00
В `config.yaml` файл ещё можно такие переменные добавить:
```yaml
2024-09-30 14:07:50 +03:00
debug: false # включает отладочные логи (false/true)
timeout: 2 # таймаут для библиотеки requests, в секундах (2 по дефолту)
2023-06-01 16:39:46 +03:00
```
2024-09-30 14:07:50 +03:00
</details>
## Хочу сделать Pull Request.
<details>
Ставьте pylint и mypy для статической проверки кода.
Конфиги уже есть в репозитории.
После проверок можете открывать PR.
</details>
## Почему конфиг для CoinAPI - список?
<details>
Можно получить несколько ключей на разные почтовые ящики
и все ключи вписать в список:
```yaml
coinapi_keys:
- key1
- key2
- etc.
```
Если вдруг один из них будет заблокирован по рейтлимиту,
бот автоматически переключится на следующий (token rotation).
</details>