mirror of
https://github.com/Redume/Shirino.git
synced 2024-11-21 07:46:23 +03:00
update readme
This commit is contained in:
parent
0c1a42791a
commit
69bd887878
1 changed files with 32 additions and 23 deletions
55
README.md
55
README.md
|
@ -1,13 +1,15 @@
|
|||
# Shirino
|
||||
|
||||
## Что это?
|
||||
Telegram-бот который выводит курс валюты используя DuckDuckGO и [CoinAPI](https://www.coinapi.io/).
|
||||
|
||||
https://t.me/Shirino_bot
|
||||
> [!NOTE]
|
||||
> Telegram-бот который выводит курс валюты используя DuckDuckGO и [CoinAPI](https://www.coinapi.io/).
|
||||
>
|
||||
> https://t.me/shirino_bot
|
||||
|
||||
## Хочу запустить
|
||||
<details>
|
||||
|
||||
Получите токен бота в телеграме и токен CoinAPI.
|
||||
Вставьте в файл `.env` в формате:
|
||||
Вставьте в файл `config.yaml` в формате:
|
||||
|
||||
```yaml
|
||||
coinapi_keys:
|
||||
|
@ -17,26 +19,33 @@ coinapi_keys:
|
|||
telegram_token: Токен Telegram-бота
|
||||
```
|
||||
|
||||
В .env файл ещё можно такие переменные добавить:
|
||||
В `config.yaml` файл ещё можно такие переменные добавить:
|
||||
```yaml
|
||||
debug: false или true, включает отладочные логи
|
||||
timeout: таймаут для библиотеки requests, в секундах (2 по дефолту)
|
||||
debug: false # включает отладочные логи (false/true)
|
||||
timeout: 2 # таймаут для библиотеки requests, в секундах (2 по дефолту)
|
||||
```
|
||||
|
||||
## Хочу сделать пулл-реквест
|
||||
Ставьте pylint и mypy для статической проверки кода.
|
||||
Конфиги уже есть в репозитории.
|
||||
После проверок можете открывать PR.
|
||||
</details>
|
||||
|
||||
## Почему энв для CoinAPI -- список?
|
||||
Можно получить несколько ключей на разные почтовые ящики
|
||||
и все ключи вписать в список:
|
||||
```yaml
|
||||
coinapi_keys:
|
||||
- key1
|
||||
- key2
|
||||
- etc.
|
||||
```
|
||||
## Хочу сделать Pull Request.
|
||||
<details>
|
||||
Ставьте pylint и mypy для статической проверки кода.
|
||||
Конфиги уже есть в репозитории.
|
||||
После проверок можете открывать PR.
|
||||
</details>
|
||||
|
||||
Если вдруг один из них будет заблокирован по рейтлимиту,
|
||||
бот автоматически переключится на следующий (token rotation).
|
||||
## Почему конфиг для CoinAPI - список?
|
||||
<details>
|
||||
Можно получить несколько ключей на разные почтовые ящики
|
||||
и все ключи вписать в список:
|
||||
|
||||
```yaml
|
||||
coinapi_keys:
|
||||
- key1
|
||||
- key2
|
||||
- etc.
|
||||
```
|
||||
|
||||
Если вдруг один из них будет заблокирован по рейтлимиту,
|
||||
бот автоматически переключится на следующий (token rotation).
|
||||
</details>
|
Loading…
Add table
Reference in a new issue