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. Клонируйте репозиторий и перейдите в каталог проекта:

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

⠀

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

python -m venv venv

⠀

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

# For Linux or macOS:
source venv/bin/activate

# For Windows:
venv\Scripts\activate

⠀

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

pip install -r requirements.txt

⠀

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

python bot.py

⠀

Important

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

⠀

📋 Todo List

⠀

• Создать данный Todo list
• Доделать readme гитхаба.
• Сделать функцию просмотра оценок
• Сделать калькулятор оценок
• Сделать возможность входа через гос-услуги

⠀

🗃️ Library stack

⠀

• Aiogram-3 - полностью асинхронный фреймворк для Telegram Bot API
• AsyncPG - библиотека Python для работы с базами данных PostgreSQL.
• Schedule - Планировщик заданий.
• Cryptography - Библиотека для обеспечения безопасности и конфиденциальности данных (шифровка данных).
• NetSchoolAPI-fork - мой форк асинхронный клиент для «Сетевого города»

⠀

💼 Credits

⠀

• NetSchoolAPI - асинхронный клиент для «Сетевого города»

⠀

👤 Author of Network City Helper

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