Artemiy b447389479 Первый этам разметки Readme.md

2025-05-02 20:50:41 +05:00

4.3 KiB

Raw Blame History

Telegram-бот для молитвенного поминания

Описание проекта

Бот предоставляет пользователям возможность отправлять имена для молитвенного поминания священнику. Система позволяет добавлять имена в разные типы записок, оставлять комментарии и управлять своими записями.

Основные функции

Типы записок:

О здравии
За упокой
Комментарии

Управление записями:

Просмотр текущих записей
Добавление новых имен
Очистка записей
Сохранение изменений

###Админ-панель:

Получение уведомлений о новых записях
Статистика использования
Управление записями

Архитектура проекта

Структура папок:

handlers/ - обработчики команд и callback-запросов
utils/ - вспомогательные функции
messages.py - текстовые сообщения
main.py - точка входа приложения
prefixes.json - файл с префиксами
requirements.txt - зависимости проекта

Основные компоненты

Обработчики:

Пользовательские команды
Callback-запросы
Админ-команды
Базовые функции
Утилиты:
Работа с базой данных

Форматирование сообщений

Отправка уведомлений
Логирование

Требования и установка

###Необходимые зависимости:

Python 3.8+
Python-telegram-bot
Дополнительные библиотеки из requirements.txt

Настройка и запуск

Настройка окружения:

Создайте файл .env с необходимыми переменными:

    TELEGRAM_TOKEN_FILE=path/to/token.txt
    TELEGRAM_DATABASE=path/to/database.json
    TELEGRAM_ADMINS=path/to/admins.txt

###Установка зависимостей:

pip install -r requirements.txt

###Запуск бота:

    python main.py

##Структура данных

**База данных: **

    Хранится в формате JSON

Структура:

        {
          "user_id": {
            "О здравии": ["имя1", "имя2"],
            "За упокой": ["имя1", "имя2"],
            "Комментарий": "текст комментария"
          }
        }

##Развертывание

Рекомендации:

Используйте Docker для деплоя
Настройте мониторинг состояния бота
Добавьте систему автоматического перезапуска
Обеспечьте регулярное резервное копирование данных

Поддержка и развитие

Документация:

    Все основные функции документированы в коде

    Добавлены комментарии к критическим участкам

Тестирование:

    Реализовано базовое логирование ошибок

    Добавлены проверки корректности данных

Контактная информация

Поддержка:

    Для вопросов и предложений обращайтесь к разработчикам

Лицензирование

Лицензия:

    MIT License

История изменений

Версия 1.0:

    Базовая функциональность

    Система уведомлений

    Управление записями

    Админ-панель

Благодарности

Команда разработчиков:

    Благодарим всех участников проекта за вклад в развитие бота

4.3 KiB Raw Blame History Unescape Escape