Redume/Shirino
1
0
Fork 0
mirror of https://github.com/Redume/Shirino.git synced 2024-11-22 00:06: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

29
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,20 +19,26 @@ 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>
## Хочу сделать Pull Request.
<details>
Ставьте pylint и mypy для статической проверки кода. Ставьте pylint и mypy для статической проверки кода.
Конфиги уже есть в репозитории. Конфиги уже есть в репозитории.
После проверок можете открывать PR. После проверок можете открывать PR.
</details>
## Почему энв для CoinAPI -- список? ## Почему конфиг для CoinAPI - список?
<details>
Можно получить несколько ключей на разные почтовые ящики Можно получить несколько ключей на разные почтовые ящики
и все ключи вписать в список: и все ключи вписать в список:
```yaml ```yaml
coinapi_keys: coinapi_keys:
- key1 - key1
@ -40,3 +48,4 @@ coinapi_keys:
Если вдруг один из них будет заблокирован по рейтлимиту, Если вдруг один из них будет заблокирован по рейтлимиту,
бот автоматически переключится на следующий (token rotation). бот автоматически переключится на следующий (token rotation).
</details>