Smartschool Parser
Unofficial Python library providing programmatic access to Smartschool's web platform. Access courses, documents, messages, results, agenda, and more through a clean, type-safe API.
Quick Start
Install from PyPI:
pip install smartschool
Create credentials.yml with your Smartschool credentials:
username: your_username
password: your_password
main_url: your_school.smartschool.be
mfa: your_birthday_or_2fa_secret # YYYY-mm-dd or Google Authenticator secret
from smartschool import Smartschool, PathCredentials, Courses
session = Smartschool(PathCredentials())
for course in Courses(session):
print(course.name)
Features
| Category | Classes | Description |
|---|---|---|
| Courses | TopNavCourses, Courses, CourseList |
Browse courses and download documents |
| Intradesk | Intradesk |
Browse and download files from the intradesk |
| My Documents | MyDocs |
Browse, download, upload and manage your personal documents |
| Results | Results, Reports, Periods |
Grades, evaluations, report cards |
| Messages | MessageHeaders, Message, Attachments, MessageComposerForm, RecipientType |
Inbox/outbox, compose, attachments, labels |
| Schedule | SmartschoolLessons, SmartschoolHours |
Daily schedules, class periods |
| Planner | PlannedElements, FutureTasks |
Assignments, deadlines, activities |
| Support | StudentSupportLinks |
School support resources |
| Student notes | StudentNotes, StudentAbsences, StudentNoteDetails |
Follow-up notes and absences registered by the school |
Documentation
Detailed usage guides with examples:
- Authentication - Credential setup and MFA
- Courses & Documents - Browsing courses and downloading files
- Intradesk - Intradesk file management
- My Documents - Personal document browsing, upload and download
- Results & Reports - Grades, evaluations, and report cards
- Messages - Inbox, compose/send, attachments, and message management
- Schedule & Agenda - Lessons, hours, and moment info
- Planner & Tasks - Planned elements and future tasks
- Student notes & absences - Follow-up notes and absences registered by the school
- Error Handling - Exception types and handling patterns
Development
git clone https://github.com/svaningelgem/smartschool.git
cd smartschool
uv sync
# Run tests
uv run pytest
# Linting & formatting
uv run ruff check .
uv run ruff format .
Requirements
- Python: 3.10+
- Core Dependencies: requests, beautifulsoup4, pydantic, pyyaml, logprise
- Optional:
pip install smartschool[mfa]for Google Authenticator 2FA support,pip install "smartschool[keyring]"to read your password from the OS keychain instead ofcredentials.yml(see Authentication)
License
GNU General Public License v3.0
Contributing
Contributions welcome! See CONTRIBUTING.md for the full guide (local setup, conventions, project layout). In short, please ensure:
- Tests pass:
uv run pytest - Code is formatted:
uv run ruff format . - Linting passes:
uv run ruff check . - Type stubs are updated:
./restub
Support
- Issues: GitHub Issues
- Changelog: CHANGELOG.md
1 maintainer
Metadata
1 maintainer
Release files for smartschool 0.12.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| smartschool-0.12.1.tar.gz | 64.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| smartschool-0.12.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 146.8 kB
Release files / smartschool-0.12.1.tar.gz
| Download URL | smartschool-0.12.1.tar.gz |
|---|---|
| Size | 64.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7ced7cfd908148818e6d9f1804efaa3c66c6fd8ab78a91264d89db21496407f2
|
|
BLAKE2b-256 checksum How to use checksums |
3e88bde306088f977cdfaf7c86694197136c35a2f96bebe01040b5a3dcf0aa90
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logRelease files / smartschool-0.12.1-py3-none-any.whl
| Download URL | smartschool-0.12.1-py3-none-any.whl |
|---|---|
| Size | 82.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6729f46ac82269687314ef2914f7fcd77ceb3fefc9e0872b7e82c1f6b3fa64dc
|
|
BLAKE2b-256 checksum How to use checksums |
b594f96af72970583ab8557d0d641f921f6a078bc378cbb6248d4561d097c069
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency log
