Edit README.md

This commit is contained in:
Артемий Колобов 2025-05-03 03:08:21 +05:00
parent b447389479
commit 634a9dfc9d

View File

@ -14,7 +14,7 @@
* Очистка записей * Очистка записей
* Сохранение изменений * Сохранение изменений
###Админ-панель: ### Админ-панель:
* Получение уведомлений о новых записях * Получение уведомлений о новых записях
* Статистика использования * Статистика использования
* Управление записями * Управление записями
@ -45,14 +45,35 @@
## Требования и установка ## Требования и установка
###Необходимые зависимости: ### Необходимые зависимости:
* Python 3.8+ * Python 3.8+
* Python-telegram-bot * Python-telegram-bot
* Дополнительные библиотеки из requirements.txt * Дополнительные библиотеки из requirements.txt
Настройка и запуск
## Настройка и запуск ## Настройка и запуск
###Контейнеризация проекта
Проект реализован с использованием Docker Compose. Конфигурация описана в файле docker-compose.yaml:
```yaml
services:
telegram-bot:
image: python
volumes:
- ./python-bot:/usr/src/app
- ./secrets:/usr/src/app/secrets
- ./requirements.txt:/usr/src/app/requirements.txt
working_dir: /usr/src/app
command: python main.py
environment:
- TELEGRAM_TOKEN_FILE=/usr/src/app/secrets/token.txt
- TELEGRAM_DATABASE=/usr/src/app/data.json
- TELEGRAM_ADMINS=/usr/src/app/secrets/admins.txt
entrypoint: ["sh", "-c", "export PIP_ROOT_USER_ACTION=ignore && pip install -r /usr/src/app/requirements.txt && pip install --upgrade pip && python main.py"]
```
### Настройка окружения: ### Настройка окружения:
* Создайте файл .env с необходимыми переменными: * Создайте файл .env с необходимыми переменными:
```bash ```bash
@ -61,18 +82,18 @@
TELEGRAM_ADMINS=path/to/admins.txt TELEGRAM_ADMINS=path/to/admins.txt
``` ```
###Установка зависимостей: ### Установка зависимостей:
```bash ```bash
pip install -r requirements.txt pip install -r requirements.txt
``` ```
###Запуск бота: ### Запуск бота:
``` bash ``` bash
python main.py python main.py
``` ```
##Структура данных ## Структура данных
**База данных: ** ### База данных:
Хранится в формате JSON Хранится в формате JSON
@ -86,7 +107,7 @@ pip install -r requirements.txt
} }
} }
``` ```
##Развертывание ## Развертывание
### Рекомендации: ### Рекомендации:
@ -95,35 +116,35 @@ pip install -r requirements.txt
* Добавьте систему автоматического перезапуска * Добавьте систему автоматического перезапуска
* Обеспечьте регулярное резервное копирование данных * Обеспечьте регулярное резервное копирование данных
Поддержка и развитие ## Поддержка и развитие
Документация: ### Документация:
Все основные функции документированы в коде Все основные функции документированы в коде
Добавлены комментарии к критическим участкам Добавлены комментарии к критическим участкам
Тестирование: ### Тестирование:
Реализовано базовое логирование ошибок Реализовано базовое логирование ошибок
Добавлены проверки корректности данных Добавлены проверки корректности данных
Контактная информация ## Контактная информация
Поддержка: ### Поддержка:
Для вопросов и предложений обращайтесь к разработчикам Для вопросов и предложений обращайтесь к разработчикам
Лицензирование ## Лицензирование
Лицензия: Лицензия:
MIT License GPL3.0
История изменений ## История изменений
Версия 1.0: ### Версия 1.0:
Базовая функциональность Базовая функциональность
@ -133,11 +154,5 @@ pip install -r requirements.txt
Админ-панель Админ-панель
Благодарности
Команда разработчиков:
Благодарим всех участников проекта за вклад в развитие бота