mtuci-private-api 0.1.2

Library for reaching MTUCI site from code

MTUCI Private API

Данная библиотека позволяет работать с ЛК МТУСИ из кода Python.
Она работает асинхронно, т.к. запросы долгие в силу специфики имитации действий браузера.

[!IMPORTANT] Библиотека работает с функционалом студентов. У меня нет возможности реализовать функционал старост или преподавателей, т.к. не располагаю такими аккаунтами.

Возможности

• Аутентификация
• Информация о пользователе
• Посещаемость. Получение актуальной посещаемости по предметам.
• Расписание. Расписание предметов можно получить на определённую дату.

Типизация

Вся библиотека типизировано настолько, насколько возможно, чтобы ей было комфортно пользоваться.

Архитектура

Библиотека имеет несколько основных модулей:

• auth для аутентификации.
• user для получения информации о пользователе.
• attendance для получения информации о посещаемости.
• schedule для получения информации о расписании.
• models для моделей данных.
• mtuci - основные классы-оркестраторы.

В каждом из модулей (кроме models) всё делится на:

• Фабрики запросов.
• Парсеры.
• Сервис.

Быстрый старт

Для старта Вам понадобится только логин и пароль от Вашего аккаунта ЛК.

import asyncio
from datetime import datetime
from src.mtuci_private_api import Mtuci

async def main():
    async with Mtuci(
        login="ваш_логин",
        password="ваш_пароль"
) as mtuci:
        # Получение информации о пользователе
        user_info = await mtuci.get_user_info()
        print(f"Студент: {user_info.name}")
        print(f"Группа: {user_info.group}")
        
        # Получение посещаемости
        attendance = await mtuci.get_attendace()
        for subject in attendance:
            print(f"{subject.subject_name}: {subject.attendance_percentage}%")
        
        # Получение расписания
        schedule = await mtuci.get_schedule(datetime(2025, 11, 21))
        for lesson in schedule.lessons:
            print(f"{lesson.start_time}: {lesson.name}")

asyncio.run(main())

Настройка логирования

Библиотека ищет в корне файл logging_config.yaml с настройкой логирования. Если не находит, то использует базовые настройки.

Сложности с аутентификацией

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

Разработка

Если Вы хотите что-то поправить или внести новый функционал, то форкните репозиторий.
Старайтесь соблюдать имеющуеся архитектуру и прибегайте к её изменению только в особых случаях.

В репозитории настроены Github Actions с тестами и линтингом, также приложен .pre-commit-config.yaml для локальных проверок перед коммитами.