Scraper for Librus Synergia
Project description
1 librusapi - A Librus Synergia scraper
Goal of this project is to free students from the limitations of Librus Synergia software mainly: giving the user fresh information unlike their mobile app that can only refresh every 3h or so.
2 Tech used
written in python developed with 3.9 in mind
requests library for fetching data, mainly html
BeautifulSoup4 library for parsing the data
2.1 Development specific
mypy for type checking
pytest for running tests
pdoc for creating html documentation
3 Quick start
Example usage of the API
3.1 Getting the timetable
from librusapi.token import get_token
from librusapi import timetable
token = get_token('username', 'password')
lesson_units = timetable.lesson_units(token)
for lu in lesson_units:
print(lu)
4 Working on the project
git clone https://github.com/ravensiris/librusapi
cd librusapi
python -m venv venv
# This may be different depending on your operating system and shell
source ./venv/bin/activate
pip install -r requirements.txt
# Installing as an editable library
pip install -e .
Now you can import librusapi in your project
4.1 Generating docs
pdoc --html librusapi
5 Status
Currenty you can:
Authenticate and get a token
List all lessons in a timetable
Copyright 2021 Maksymilian Jodłowski
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.