devzilla/discordBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: актуализировал README.md — тесты, зависимости, .env.example

Browse Source
This commit is contained in:
deadzilla 2026-07-07 22:27:02 +05:00
parent d1c64a5a2b
commit 2d890bea98
2 changed files with 25 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.env.example
View File

@ -2,3 +2,11 @@ DISCORD_TOKEN=your_bot_token_here
MORNING_TIME=07:00 MORNING_TIME=07:00
MORNING_CHANNEL_ID=channel_id MORNING_CHANNEL_ID=channel_id
LOG_LEVEL=INFO LOG_LEVEL=INFO
CAT_API_RATE=1
CAT_API_BURST=3
WEATHER_API_RATE=1
WEATHER_API_BURST=3
OPEN_METEO_API_RATE=2
OPEN_METEO_API_BURST=5
HABR_RSS_RATE=1
HABR_RSS_BURST=2

26
README.md
View File

@ -46,7 +46,7 @@ python bot.py
## Архитектура ## Архитектура
``` ```
bot.py # Точка входа, инициализация бота bot.py # Точка входа, инициализация бота, команда !msg (в BotRunner._setup_events)
commands/ # Discord команды (cogs) commands/ # Discord команды (cogs)
__init__.py # ALL_COMMANDS — явные импорты __init__.py # ALL_COMMANDS — явные импорты
pg.py # !pg — погода (обёртка над utils.pogoda) pg.py # !pg — погода (обёртка над utils.pogoda)
@ -100,20 +100,20 @@ python -m pytest tests/ -v
| Файл | Что тестирует | Кол-во | | Файл | Что тестирует | Кол-во |
|------|---------------|--------| |------|---------------|--------|
| `test_pogoda.py` | `translate_weather()`, `pressure_to_mmhg()`, `wmo_to_russian()`, `format_weather_data_for_console()` | 93 | | `test_pogoda.py` | `translate_weather()`, `pressure_to_mmhg()`, `wmo_to_russian()`, `format_weather_data_for_console()` | 27 |
| `test_fetch_cat.py` | `fetch_cat()` | 10 | | `test_fetch_cat.py` | `fetch_cat()` | 10 |
| `test_fetch_rss.py` | `fetch_rss()` | 20 | | `test_fetch_rss.py` | `fetch_rss()` | 21 |
| `test_fetch_weather.py` | `fetch_weather()`, `fetch_open_meteo()` | 20 | | `test_fetch_weather.py` | `fetch_weather()`, `fetch_open_meteo()` | 19 |
| `test_format_articles.py` | `truncate_title()`, `_parse_date()`, `format_articles()` | 24 | | `test_format_articles.py` | `truncate_title()`, `_parse_date()`, `format_articles()` | 20 |
| `test_commands_pg.py` | `Pg` cog, команда `!pg` | 13 | | `test_commands_pg.py` | `Pg` cog, команда `!pg` | 13 |
| `test_bot.py` | инициализация бота | 7 | | `test_bot.py` | инициализация бота | 5 |
| `test_morning_runner.py` | morning runner-а | 68 | | `test_morning_runner.py` | morning runner | 12 |
| `test_help_discord.py` | команда `!hp` | 2 | | `test_help_discord.py` | команда `!hp` | 2 |
| `test_logger.py` | `setup_logging` (уровни, обработчики, формат) | 9 | | `test_logger.py` | `setup_logging` (уровни, обработчики, формат) | 9 |
| `test_rate_limiter.py` | `RateLimiter` (токен-бакет) | 5 | | `test_rate_limiter.py` | `RateLimiter` (токен-бакет) | 5 |
| `test_commands_status.py` | команда `!status` (embed, uptime) | 6 | | `test_commands_status.py` | команда `!status` (embed, uptime) | 6 |
| `test_commands_stats.py` | команда `!stats` (серверы, каналы) | 4 | | `test_commands_stats.py` | команда `!stats` (серверы, каналы) | 5 |
**Итого: 227 теста.** **Итого: 154 теста.**
## Запуск в Docker ## Запуск в Docker
@ -194,6 +194,7 @@ DISCORD_TOKEN=ваш_токен docker-compose up
| `OPEN_METEO_API_BURST` | Burst-бакет Open-Meteo | `.env`, по умолчанию `5` | | `OPEN_METEO_API_BURST` | Burst-бакет Open-Meteo | `.env`, по умолчанию `5` |
| `HABR_RSS_RATE` | Rate-limit Habr RSS (токенов/сек) | `.env`, по умолчанию `1` | | `HABR_RSS_RATE` | Rate-limit Habr RSS (токенов/сек) | `.env`, по умолчанию `1` |
| `HABR_RSS_BURST` | Burst-бакет Habr RSS | `.env`, по умолчанию `2` | | `HABR_RSS_BURST` | Burst-бакет Habr RSS | `.env`, по умолчанию `2` |
| `LOG_LEVEL` | Уровень логирования | `.env`, по умолчанию `INFO` (DEBUG, WARNING, ERROR, CRITICAL) |
## Логирование ## Логирование
@ -208,10 +209,17 @@ DISCORD_TOKEN=ваш_токен docker-compose up
## Зависимости ## Зависимости
### Production (`requirements.txt`)
```txt ```txt
discord.py>=2.3.2 discord.py>=2.3.2
python-dotenv>=1.0.0 python-dotenv>=1.0.0
requests>=2.31.0 requests>=2.31.0
```
### Development (`requirements-dev.txt`)
```txt
pytest>=7.4.0 pytest>=7.4.0
pytest-asyncio>=0.21.0 pytest-asyncio>=0.21.0
``` ```