https://github.com/mrconsoleka/network-city-helper

🤖 Telegram bot to help students study
https://github.com/mrconsoleka/network-city-helper

aiogram3 netschool python3 sgo-edu telegram telegram-bot

Last synced: about 1 year ago
JSON representation

🤖 Telegram bot to help students study

• Host: GitHub
• URL: https://github.com/mrconsoleka/network-city-helper
• Owner: MrConsoleka
• License: mit
• Created: 2024-11-11T09:34:22.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-12-01T10:09:21.000Z (over 1 year ago)
• Last Synced: 2025-05-09T02:00:06.788Z (about 1 year ago)
• Topics: aiogram3, netschool, python3, sgo-edu, telegram, telegram-bot
• Language: Python
• Homepage: https://t.me/sgo_edu_helper_bot
• Size: 943 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

          




Network City Helper












⠀


> [!CAUTION]

> Бот не имеет отношения к «ИрТеху»

⠀

## 📌 Description

⠀

**Network City Helper** — это ваш персональный телеграм-бот, созданный для оказания помощи ученикам в учебном процессе. Он взаимодействует с платформой "Сетевой город", предлагает широкий спектр функций, направленных на упрощение организации учебного времени и управления задачами. Бот может отправлять итоговые оценки и уведомления о просроченных заданиях, а также делиться актуальным расписанием и домашним заданием на завтрашний день.

_Тем не менее, стоит отметить, что предоставленный код нуждается в доработке. В текущем виде он может содержать избыточные участки кода, которые могут быть оптимизированы для повышения производительности и улучшения читаемости._

⠀

## 🔨 Functions

⠀

### 📗 Пользователские:

* `/start` - запуск бота

* `/help` - помощь

* `/menu` - меню бота

### 📕 Администраторские:

* `/bells_load` - загрузить расписания звонков

* `/holidays_load` - загрузить расписания каникул

* `/timetable_load` - загрузить расписания уроков

⠀

## 🔓 Bot .env

⠀

| Имя переменной среды      | Описание                                                     |

|---------------------------|--------------------------------------------------------------|

| BOT_TOKEN                 | Токен от вашего Telegram-бота, вы можете получить его в Telegram в боте с логином @botfather.|

| LOGGER                    | Уровень лоигрования (BASE, FULL)|

| SECRET_KEY                | Секретный ключ шифрования данных для бд|

| PARSE_MODE                | Мод парсинга (HTML, MARKDOWNV2) |

| ADMINS_ID                 | Айди администраторов|

| DB_SQL                    | Название используемой sql (по умолчанию PostgreSQL)|

| DB_LIB                    | Библиотека для взаимодейсвтия с бд|

| DB_LOGIN                  | Логин пользователя бд|

| DB_PASSWORD               | Пароль пользователя бд|

| DB_HOST                   | Хост бд|

| DB_PORT                   | Порт бд|

| DB_NAME                   | Имя бд|

⠀

## 💻 Bot setup

⠀

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

```shell

git clone https://github.com/MrEnderman-YT/Network-City-Helper.git

cd Network-City-Helper

```

⠀

2. Создайте виртуальное окружение

```shell

python -m venv venv

```

⠀

3. Активируйте виртуальное окружение

```shell

# For Linux or macOS:

source venv/bin/activate

# For Windows:

venv\Scripts\activate

```

⠀

4. Установите нужные библиотеки из файла `requirements.txt`:

```shell

pip install -r requirements.txt

```

⠀

5. Для запуска бота используйте команду:

```

python bot.py

```

⠀

> [!IMPORTANT]

> Используйте версию python 3.11 и ниже!

> 

⠀

## 📋 Todo List

⠀

- [x] Создать данный Todo list

- [x] Доделать readme гитхаба.

- [ ] Сделать функцию просмотра оценок

- [ ] Сделать калькулятор оценок

- [ ] Сделать возможность входа через гос-услуги

⠀

## 🗃️ Library stack

⠀

* [Aiogram-3](https://github.com/aiogram/aiogram) - полностью асинхронный фреймворк для Telegram Bot API

* [AsyncPG](https://github.com/MagicStack/asyncpg) - библиотека Python для работы с базами данных PostgreSQL.

* [Schedule](https://pypi.org/project/schedule/) - Планировщик заданий.

* [Cryptography](https://pypi.org/project/cryptography/) - Библиотека для обеспечения безопасности и конфиденциальности данных (шифровка данных).

* [NetSchoolAPI-fork](https://github.com/MrEnderman-YT/netschoolapi) - мой форк асинхронный клиент для «Сетевого города»

⠀

## 💼 Credits

⠀

* [NetSchoolAPI](https://github.com/nm17/netschoolapi) - асинхронный клиент для «Сетевого города»

⠀

## 👤 Author of Network City Helper

**© Алексеев Роман**