Redume/Shirino
1
0
Fork 0
mirror of https://github.com/Redume/Shirino.git synced 2024-11-21 15:56:22 +03:00
Code Issues Projects Releases Packages Wiki Activity

update readme

Browse source
This commit is contained in:
Данил 2024-09-30 14:07:50 +03:00
parent 0c1a42791a
commit 69bd887878
1 changed files with 32 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
README.md
View file

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