docs: актуализировать README.md под pyproject.toml
Установка: pip install -r requirements.txt → pip install . Архитектура: добавлен pyproject.toml в список файлов. Зависимости: pyproject.toml указан как основной источник.
This commit is contained in:
parent
34f280e814
commit
974c236489
16
README.md
16
README.md
@ -5,7 +5,13 @@ Discord-бот для Магнитогорска. Команды погоды,
|
||||
## Установка
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
pip install .
|
||||
```
|
||||
|
||||
Или с dev-зависимостями:
|
||||
|
||||
```bash
|
||||
pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
## Запуск
|
||||
@ -89,6 +95,7 @@ docker-compose.yml # Запуск бота в Docker
|
||||
.dockerignore # Исключения для Docker-контекста
|
||||
.gitignore # Исключения для Git (venv, .env, логи, IDE)
|
||||
.pre-commit-config.yaml # pre-commit хуки (ruff lint + ruff-format)
|
||||
pyproject.toml # Единый файл конфигурации: зависимости, pytest, ruff
|
||||
```
|
||||
|
||||
### Добавление Discord команды
|
||||
@ -243,7 +250,10 @@ DISCORD_TOKEN=ваш_токен docker-compose up
|
||||
|
||||
## Зависимости
|
||||
|
||||
### Production (`requirements.txt`)
|
||||
Зависимости объявлены в `pyproject.toml` (`[project].dependencies` и `[project.optional-dependencies].dev`).
|
||||
Файлы `requirements.txt` и `requirements-dev.txt` сохранены для обратной совместимости.
|
||||
|
||||
### Production
|
||||
|
||||
```txt
|
||||
discord.py~=2.7.1
|
||||
@ -252,7 +262,7 @@ requests~=2.34.2
|
||||
defusedxml~=0.7.1
|
||||
```
|
||||
|
||||
### Development (`requirements-dev.txt`)
|
||||
### Development
|
||||
|
||||
```txt
|
||||
pre-commit>=3.5.0
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user