Unofficial API interface to the smartschool system.
Project description
Smartschool parser
Unofficial interpreter to interface against smartschool's website.
How to use?
Copy the credentials.yml.example
file to credentials.yml
and adjust the contents with the username/password and school uri.
from smartschool import SmartSchool, PathCredentials, Courses
SmartSchool.start(PathCredentials())
for course in Courses():
print(course.name)
Implemented:
- AgendaLessons
- AgendaHours
- AgendaMomentInfos
- TopNavCourses
- Courses
- FutureTasks
- Periods
- Results
- StudentSupportLinks
- MessageHeaders
- Message
- Attachments
- MarkMessageUnread
- AdjustMessageLabel
- MessageMoveToArchive
- MessageMoveToTrash
Contributing?
To get started (I always use mamba/conda to create an environment)
git clone https://github.com/svaningelgem/smartschool.git
cd smartschool
mamba create -n smartschool python=3.11
mamba activate smartschool
pip install poetry
poetry install
Now you can start contributing.
To run the test suite:
poetry run pytest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
smartschool-0.4.0.tar.gz
(30.5 kB
view hashes)
Built Distribution
Close
Hashes for smartschool-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | faba4b7bd5485710dcd7f42194b2a8f68cb9150f57edf9e633b1fc1b915f00a1 |
|
MD5 | 63eb2559f125c6dd41c0f801366c0d7d |
|
BLAKE2b-256 | 7b9ae000692be750dbbe8024f718417ddfad444c086f7c02419f8ea83dce0681 |