Skip to content
unlaeshPublic

About

Telegram-бот с расписанием пар ЮУрГУ: расписание на день и неделю, напоминания о следующей паре и аудитории, заметки к занятиям.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

ЮУрГУ.Пары

Учебный проект Telegram-бота с расписанием пар для студентов ЮУрГУ. Планируемые функции: просмотр расписания, заметки к занятиям и напоминания о следующей паре.

Статус: реализованы HTTP-каркас и компонент навигации Telegram; регистрация, расписание и транспорт бота ещё в разработке. Начало учебного проекта: 21.09.2026. План оставшейся работы: 12.11.2026 – 15.12.2026; срок готовности — 15 декабря.

Текущее состояние

Состояние кода и результатов исследования на 12.11.2026:

Компонент Фактическое состояние
HTTP-сервис Реализованы приложение FastAPI, запуск через Uvicorn и настройки PARY_*
GET /health Возвращает статус ok и версию; проверяет живость процесса, без проверки базы данных
Тесты приложения 24 проверки: два теста /health и 22 теста навигации без обращения к Telegram
CI Настроены Ruff, проверка форматирования и Pytest в GitHub Actions
Навигация Telegram Кнопки «Сегодня», «Завтра», «Неделя», «Настройки», возврат в главное меню и подключение заметок при готовом обработчике
Регистрация, расписание и транспорт Telegram Обработчики бизнес-сценариев, вебхук и запуск полноценного бота ещё не реализованы
Источник расписания Исследован публичный HTML ЮУрГУ; результаты и ограничения — в исследовании #13
Парсер, БД, заметки и уведомления Подготовлены пустые модули; реализация запланирована
Контейнеризация, миграции и деплой Файлы Docker и Alembic пока пусты; сборка и деплой в CI не настроены

Описание функций ниже и страницы Requirements, Architecture и WBS задают целевой результат и план работ. Наличие требования или файла-заготовки не означает готовность функции.

Зачем

Проект решает потребность студента быстро узнать следующую пару и аудиторию в привычном мессенджере, а также хранить домашние задания рядом с расписанием. Исходный сценарий — открыть расписание на online.susu.ru и найти нужный день; результат проверки доступа и публичная альтернатива описаны в исследовании источника.

Планируемое решение переносит просмотр расписания в Telegram: заметки будут привязаны к конкретной паре, а напоминания помогут заранее подготовиться к занятию.

Планируемые возможности

После реализации пользователь сможет указать свою группу и пользоваться следующими функциями:

Возможность Этап
Расписание на сегодня, завтра и неделю одной командой: название пары, время, аудитория, преподаватель MVP
Текстовые заметки к парам (домашнее задание, записанные текстом дедлайны), видимые вместе с расписанием релиз 1.1
Уведомление о следующей паре и аудитории за выбранное время до начала релиз 1.2
Уведомления об изменениях в расписании релиз 1.2

В учебной версии все перечисленные функции бесплатны. Автоматические напоминания по дедлайнам — идея дальнейшего развития, не входящая в требования релиза 1.2.

Роли в системе:

Роль Что делает
Пользователь Смотрит расписание, ведёт заметки к парам, настраивает уведомления
Администратор Просматривает пользователей
Сервис Парсит расписание с сайта ЮУрГУ

Технологии

В текущем коде используются Python 3.12+, FastAPI, Uvicorn, Pydantic Settings и aiogram 3 для навигационного компонента; для проверок — Pytest, HTTPX и Ruff.

Целевой стек остальных компонентов:

Задача Технология
Транспорт и прикладные сценарии Telegram FastAPI + aiogram; навигационный компонент уже реализован
База данных PostgreSQL
Миграции базы данных Alembic
Парсинг расписания Playwright, BeautifulSoup
Развёртывание Docker Compose, Nginx, VPS

Компонент навигации не включает остальные прикладные сервисы из таблицы. Согласно целевой архитектуре, обмен данными между сервисами будет идти через PostgreSQL; брокер сообщений не предусмотрен.

Запуск текущего HTTP-каркаса

Нужен Python 3.12 или новее.

python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
cp .env.example .env          # локальные настройки; .env не коммитится

python -m pary.api            # HTTP-сервис на http://127.0.0.1:8000
curl http://127.0.0.1:8000/health

Для /health токен Telegram и база данных не нужны. Команда запускает HTTP-сервис; вебхук и получение обновлений Telegram ещё не подключены. Навигационный router проверяется отдельно, без токена и сети.

Компонент навигации Telegram

pary.bot.MenuHandlers принимает четыре готовых асинхронных обработчика разделов. create_menu_router(handlers) передаёт им нажатия кнопок; show_main_menu(message, handlers=handlers) вызывается после проверки регистрации. Вложенный обработчик добавляет back_to_menu_keyboard() к ответу. Возврат в главное меню отменяет незавершённый диалог и очищает его FSM-состояние, сохраняя бизнес-данные в области ответственности соответствующего сервиса.

Заметки включаются только передачей готового notes-обработчика. /start, неизвестный текст и команды остаются другим router; модуль не подменяет регистрацию, загрузку расписания или настройки. Это компонент для последующего подключения, а не запущенный Telegram-бот.

pytest tests/test_bot_navigation.py

Проверки CI (GitHub Actions) настроены для push в любую ветку и pull request в main:

ruff check .
ruff format --check .
pytest

План работ

С 12 ноября пересматривается план оставшейся работы: ранее выполненные задачи учитываются как выполненные и не оцениваются заново как будущая разработка.

Параметр Принято для нового плана
Период оставшейся работы 12.11–15.12.2026 включительно
Крайний срок готовности 15.12.2026
Расчётный календарь 34 календарных дня, из них 24 будних дня при пятидневной неделе
Итерации Пять: 12–18.11, 19–25.11, 26.11–02.12, 03–09.12, 10–15.12
Резерв внутри срока 60 ч по ролям размещены на 10–15.12; 14–15.12 частично заняты обратной связью и итоговыми материалами

Проверенный учебный календарь включает 296,82 чел.-ч обязательного MVP и 60 ч размещённого резерва при доступности 4 ч на роль в будний день. Отложенный объём — 152 ч. Это модель планирования, а не подтверждение реального состава команды. Три ближайшие итерации и текущая доска описаны в плане итераций. Ограничения источника, выявленные в пункте 12, требуют решения до реализации парсера; календарь сохраняет статус условного плана.

30 дней на MVP и ещё 10 дней на заметки — исходные оценки из ранней Concept. Они сохранены как история и не используются вместо рассчитанного календаря.

Обязательная часть — MVP. Заметки, уведомления и панель администратора остаются в отложенном объёме без обещанных дат.

Цель проекта

К 15 декабря 2026 года выпустить обязательный MVP Telegram-бота с выбором группы и просмотром расписания ЮУрГУ. За первые 30 дней после фактического релиза MVP привлечь не менее 60 студентов, причём не менее половины из них должны обращаться к боту каждую неделю.

Как ведётся проект

Для учебного проекта выбрана гибридная рамка управления:

  • от PMBOK — устав, концепция, оценка экономики, фиксированные контрольные точки и дата завершения;
  • от Agile — недельные итерации, доска задач в GitHub Projects, приоритизированный бэклог, демонстрация результата в конце каждой итерации.

Один из технических рисков — изменение структуры сайта с расписанием. Для парсера запланированы редкие запросы и кеширование в базе. Хранение учётных данных пользователей от портала вуза не предусмотрено; наблюдённый публичный источник и непроверенные условия его использования описаны в исследовании #13.

Монетизация

В рамках учебного курса расписание, заметки и уведомления планируются бесплатными. Подписка за 59 ₽ в месяц — гипотеза коммерческого развития после курса, используемая в экономическом расчёте, а не действующий тариф. Оплата, проверка подписки и напоминания по дедлайнам не входят в текущий план реализации.

В принятой расчётной модели проект в рамках одного вуза не окупается, поэтому учебная версия рассматривается как некоммерческая. Решение о платных функциях и подключении других вузов потребует проверки спроса после релиза.

Учебная модель команды

Для лабораторных работ используется следующая учебная модель команды и распределения ролей:

Участник Роль
Ревягин Денис Владелец продукта, ведущий разработчик
Соколова Алина Scrum-мастер
Кузнецов Максим Разработчик: парсер и база данных
Белов Артём Разработчик: Telegram-бот
Морозова Екатерина Тестировщик

Роли и зоны ответственности — на странице Team.

Definition of Done

Правила проверки результата, приёмки и завершения задач определены на странице Development. Они задают критерии готовности; наличие задачи в WBS или описания в wiki само по себе не подтверждает их выполнение.

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

Подробности — в wiki проекта:

  • Ideas — три идеи проекта;
  • Evaluation — оценка идей по взвешенным критериям и выбор идеи;
  • Concept — концепция, устав, цель по SMART, классификация, экономика (точка безубыточности, NPV);
  • Stakeholders — реестр заинтересованных сторон и матрица «интерес/влияние»;
  • Requirements — планируемые функции и пользовательские сценарии;
  • Non-Functional-Requirements — нефункциональные требования и способы проверки;
  • Architecture — целевая архитектура и текущее состояние реализации;
  • WBS — декомпозиция запланированных работ.

Лицензия

Исходный код открыт для просмотра и запуска в учебных целях и для оценки проекта. Коммерческое использование, распространение и развёртывание без письменного согласия автора запрещены. Подробности — в файле license.

About

Telegram-бот с расписанием пар ЮУрГУ: расписание на день и неделю, напоминания о следующей паре и аудитории, заметки к занятиям.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages