bgtu-parser — brand new parser for obtaining schedule

v2.1.2 — rebase to FastAPI, refactoring

Table of contents

• Requirements
• How to launch
• How to use
• How to make requests
  • Requests list
• To-do list
• Credits

Requirements

• Selenium — pip install selenium
• FastAPI — pip install fastapi
• pydantic — pip install pydantic
• uvicorn — pip install uvicorn

How to launch

1. Open Terminal or cmd
2. Change directory to one which contains the app with the cd command
3. Install all dependencies from requirements.txt: pip install -r requirements.txt (or manually)
4. Run parser: python app.py

How to use

1. Launch parser
2. Open http://localhost:8443/ in your browser
3. If there is a documentation on the index page, then all systems are operational. You are ready to make some requests.

How to make requests

Basically, you can use built-in Swagger UI to interact with API, but the most common way is to make request from another program.

Requests list

There are two types of requests at the moment:

1. Get schedule: get_schedule(group) http://localhost:8443/api/v2/schedule?group=group, where group parameter is your group.
2. Get group list: get_groups(faculty, year) http://localhost:8443/api/v2/groups?faculty=faculty&year=year, where faculty and year — your parameters.

There are all of the requests you can perform, using bgtu-parser.

To-do list

• Create a parser, fill it with basic function — obtaining schedule
• Add obtaining the group list feature
• Refactor all the code so it doesn’t look messy and full of unnecessary comments
• Rebase on FastAPI
• Add a feature to get information about teachers and their schedule
• Add a function to get a departments, faculties and information about them

Credits

All credits goes to xhable1337, author of this repository.