Skip to main content

Library for reaching MTUCI site from code

Project description

Tests Python License: GPL v3

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())

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

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

Разработка

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mtuci_private_api-0.1.0.tar.gz (19.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mtuci_private_api-0.1.0-py3-none-any.whl (45.9 kB view details)

Uploaded Python 3

File details

Details for the file mtuci_private_api-0.1.0.tar.gz.

File metadata

  • Download URL: mtuci_private_api-0.1.0.tar.gz
  • Upload date:
  • Size: 19.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for mtuci_private_api-0.1.0.tar.gz
Algorithm Hash digest
SHA256 afe44d2bbaa72709653ba25035fa6565716b43d90e87dd7866df3fa2510fc114
MD5 c3f58f2fddd407ff20d9dd1b3b14b999
BLAKE2b-256 de24b4c2b7cda37bae36ec61c56698fa15e5607754ff9033c66ca63dbb738d80

See more details on using hashes here.

File details

Details for the file mtuci_private_api-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mtuci_private_api-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 84ce574535c7ce4bda8613105ce60e170394cddd582769999a186ce0d7171692
MD5 f17e0772ebf3f2c5db4be0dd62c098a8
BLAKE2b-256 7c3e50598b84c8f951e45a11643344b9acdb36d16226e0bfd41d337369dd01d3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page