Skip to main content

pyedookit

PyPI CI

Unofficial async Python client for the Edookit parent portal (https://<school>.edookit.net) used by Czech schools. It powers the ha-edookit Home Assistant integration and works standalone.

Edookit's REST API only works if a school administrator enables it, so this library signs in like a parent does (Plus4U OIDC, no browser) and reads the portal's pages. Edookit doesn't support it, and a change to the portal's markup can break a parser until it's updated.

Install

pip install pyedookit

Requires Python 3.12+.

Usage

import asyncio
from pyedookit import EdookitClient, login

async def main():
    session = await login("zs-example", "parent@example.com", "hunter2")
    client = EdookitClient(session)
    for lesson in await client.get_timetable():
        print(lesson.start, lesson.subject, lesson.room)

asyncio.run(main())
Call Returns
get_timetable() this week's Lessons, times in PORTAL_TZ (Europe/Prague)
get_events() upcoming SchoolEvents; all-day events have date start/end, end inclusive
get_payments() Payments totals and requests, amounts as Decimal
fetch_page(name) raw HTML of a page without a parser yet (CAPTURE_PAGES)

content_fingerprint(html) tells you when such a page's content changed.

Sessions

The password is only used by login(). Store session.to_json() instead, and treat it like a password: it holds the Plus4U cookie, which signs in for about 19 days. Load it with Session.from_json().

The edookit session itself lasts 30-60 minutes. When it runs out, call refresh(session) to get a new one from the Plus4U cookie. When refresh() raises AuthError, the Plus4U cookie has expired too and you need login() again.

Exception Meaning What to do
SessionExpired the edookit session ran out refresh() and retry
AuthError bad credentials, or the Plus4U cookie expired login()
EdookitConnectionError network error or 30 s timeout retry later
ParseError the portal's markup changed the parser needs updating

All of them derive from EdookitError. login(), refresh() and EdookitClient accept an http: aiohttp.ClientSession to reuse. Create it with cookie_jar=aiohttp.DummyCookieJar(): cookies are handled per host by hand, and a real jar would resend them.

Limitations

  • Current week only. The portal ignores week_offset=1, and the real week-navigation parameter hasn't been found yet. A browser HAR trace of clicking the next-week arrow would solve it; scripts/capture_fixtures.py captures portal HTML.
  • Cancelled and changed lessons are unverified. No real capture has had one yet, so Lesson.is_changed and is_cancelled are always False.
  • Unpaid payment requests are unverified. Only paid ones have been seen. A request without the "accepted" marker is reported as unpaid.

Development

uv sync --group dev
uv run pytest
uv run ruff check .
uv run mypy src

To release, bump version in pyproject.toml and push a vX.Y.Z tag. The publish workflow checks that the tag matches the version, then tests, builds and uploads to PyPI with trusted publishing.

Metadata

Release files for pyedookit 0.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyedookit 0.3.2
File Size Uploaded Provenance
pyedookit-0.3.2.tar.gz 25.1 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for pyedookit 0.3.2
File Interpreter ABI Platform
pyedookit-0.3.2-py3-none-any.whl Python 3 none any Details

Total release size: 45.5 kB

Release files / pyedookit-0.3.2.tar.gz

Download URL pyedookit-0.3.2.tar.gz
Size 25.1 kB
Tags Source
SHA-256 checksum
How to use checksums
1514a81b3507c0e30ccd3435cd435a6379e041d42bd3c86abc71d5b81887a4e1
BLAKE2b-256 checksum
How to use checksums
227f30568f5b05416b9abf0602583190bd4f527a423670995a4fe8d7b973a1ff
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 10, 2026.

Transparency log

Release files / pyedookit-0.3.2-py3-none-any.whl

Download URL pyedookit-0.3.2-py3-none-any.whl
Size 20.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
78a39f06f0ee5db1cf9056e48d2ca5806bcddab5c0a7fcc318a3761378575c5a
BLAKE2b-256 checksum
How to use checksums
56a0850680d6add5d874fa277b26ace1506c1cc170441ee5c0fa383218625c55
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 10, 2026.

Transparency log

Security for pyedookit 0.3.2

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.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for pyedookit-0.3.2.tar.gz

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 10, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page