smartschool 0.2.0

Unofficial API interface to the smartschool system.

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