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 |
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
- Error Handling - Exception types and handling patterns
Development
git clone https://github.com/svaningelgem/smartschool.git
cd smartschool
pip install poetry
poetry install
# Run tests
poetry run pytest
# Linting & formatting
poetry run ruff check .
poetry run ruff format .
Requirements
- Python: 3.10+
- Core Dependencies: requests, beautifulsoup4, pydantic, pyyaml, logprise
- Optional:
pip install smartschool[mfa]for Google Authenticator 2FA support
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:
poetry run pytest - Code is formatted:
poetry run ruff format . - Linting passes:
poetry run ruff check . - Type stubs are updated:
./restub
Support
- Issues: GitHub Issues
- Changelog: CHANGELOG.md
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file smartschool-0.10.0.tar.gz.
File metadata
- Download URL: smartschool-0.10.0.tar.gz
- Upload date:
- Size: 56.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
186da76c7021e01c1ef6fcf7adfb453cd0f515363d0b7947b3fcacb6d99f5df9
|
|
| MD5 |
e969b8e0fbfd9706a0ecdd6dfbd94d25
|
|
| BLAKE2b-256 |
10d85241bad9f09ed69a81ed17d09c6b51af57832afb8e3e0dc24f0fab03bbcf
|
Provenance
The following attestation bundles were made for smartschool-0.10.0.tar.gz:
Publisher:
release.yml on svaningelgem/smartschool
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
smartschool-0.10.0.tar.gz -
Subject digest:
186da76c7021e01c1ef6fcf7adfb453cd0f515363d0b7947b3fcacb6d99f5df9 - Sigstore transparency entry: 2233954546
- Sigstore integration time:
-
Permalink:
svaningelgem/smartschool@28880d7c49aa75179112d91a712a7bed70862a49 -
Branch / Tag:
refs/tags/0.10.0 - Owner: https://github.com/svaningelgem
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@28880d7c49aa75179112d91a712a7bed70862a49 -
Trigger Event:
push
-
Statement type:
File details
Details for the file smartschool-0.10.0-py3-none-any.whl.
File metadata
- Download URL: smartschool-0.10.0-py3-none-any.whl
- Upload date:
- Size: 69.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d7797d8dc3b415fc32bd99546951f3cf78878c881d0cb61eef0752f341df5737
|
|
| MD5 |
46397a468010eb7bee32c1a95a59b057
|
|
| BLAKE2b-256 |
080611685d7ae01cef671dddd8bf3623fab0d73309d591b57571cad51382992f
|
Provenance
The following attestation bundles were made for smartschool-0.10.0-py3-none-any.whl:
Publisher:
release.yml on svaningelgem/smartschool
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
smartschool-0.10.0-py3-none-any.whl -
Subject digest:
d7797d8dc3b415fc32bd99546951f3cf78878c881d0cb61eef0752f341df5737 - Sigstore transparency entry: 2233956032
- Sigstore integration time:
-
Permalink:
svaningelgem/smartschool@28880d7c49aa75179112d91a712a7bed70862a49 -
Branch / Tag:
refs/tags/0.10.0 - Owner: https://github.com/svaningelgem
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@28880d7c49aa75179112d91a712a7bed70862a49 -
Trigger Event:
push
-
Statement type:
