Shirino/README.md

26 lines
990 B
Markdown
Raw Normal View History

2023-05-30 13:59:36 +03:00
# Shirino
## Что это?
2023-05-30 14:18:23 +03:00
Telegram-бот который выводит курс валюты используя DuckDuckGO и [CoinAPI](https://www.coinapi.io/).
2023-05-30 13:51:10 +03:00
https://t.me/Shirino_bot
2023-05-30 13:59:36 +03:00
## Хочу запустить
Получите токен бота в телеграме и токен CoinAPI.
Вставьте в файл `.env` в формате:
2023-05-30 14:18:23 +03:00
2023-05-30 13:59:36 +03:00
```
2023-05-30 14:18:23 +03:00
COINAPI_KEY=Токен от апи CoinAPI
TELEGRAM_TOKEN=Токен Telegram-бота
2023-05-30 13:59:36 +03:00
```
2023-05-30 14:18:23 +03:00
В .env файл ещё можно такие переменные добавить:
2023-05-30 13:59:36 +03:00
```
DEBUG=false или true, включает отладочные логи
TIMEOUT=таймаут для библиотеки requests, в секундах (2 по дефолту)
```
## Хочу сделать пулл-реквест
Ставьте pylint и mypy для статической проверки кода.
Конфиги уже есть в репозитории.
После проверок можете открывать PR.