pacman-city/StudySentryBot

StudySentryBot - личный 🤖 ассистент в Telegram, который уведомляет о статусе проверки домашних работ на курсе 📚 Yandex Practicum 📚.

StudySentryBot

О проекте

Telegram бот для оповещения о статусе code-review проекта на курсе Yandex Practicum.
Проект объединяет работу REST API Yandex Practicum и Telegram, предоставляя студентам удобный способ отслеживать статус своих домашних работ.

Основная цель проекта

StudySentryBot разработан для студентов Yandex Practicum, чтобы помочь им следить за статусами и изменениями в проверке и ревью их домашних работ.

Технологии и инструменты

Функциональность бота

• Раз в 10 минут опрашивает API Yandex Practicum и проверяет статус отправленных на ревью домашних работ.
• При обновлении статуса анализирует ответ API и отправляет уведомление в Telegram.
• Логирует свою работу и уведомляет об важных проблемах через Telegram.

Примеры уведомлений бота:

StudySentryBot отправляет следующие уведомления о статусе проверки домашней работы ревьюером:

1. Уведомление о принятии домашней работы на ревью.
2. Уведомление о завершении проверки домашней работы.
3. Уведомление о доработке домашней работы, если требуются исправления.

Такие уведомления помогают студентам быстро и удобно следить за статусом своих заданий на платформе Yandex Practicum.

Запуск проекта

Чтобы запустить проект, выполните следующие шаги:

1. Клонируйте проект и перейдите в него:

   git clone https://github.com/kluevevga/StudySentryBot
   cd StudySentryBot

2. Установите виртуальное окружение:

   python3 -m venv venv

3. Активируйте окружение:

   • Windows (PowerShell):

   .\venv\Scripts\Activate.ps1

   • Windows (Git Bash):

   source venv/Scripts/activate

   • Linux (Bash):

   source venv/bin/activate

4. Установите зависимости:

   pip install -r requirements.txt

5. Запустите проект:

   python3 homework.py

Лицензия 📜

Этот проект распространяется под лицензией MIT. Дополнительную информацию можно найти в файле LICENSE.