Aula

Unofficial async Python client for the Danish school platform aula.dk. The project delivers:

1. Async Python API client — programmatic access to profiles, messages, calendar, posts, and more
2. CLI — read messages, calendar, posts, presence, and widget data from the terminal
3. AI agent skill — teach Claude Code or OpenCode to query school data

Table of Contents

• Installation
• Quick Start
• Authentication
• CLI
• Configuration
• AI Agent Integration
• Project Structure
• Attribution
• License

Installation

pip install aula
# or with uv
uv add aula

Requirements: Python >= 3.14, MitID username and MitID app.

Run without installing

Use uvx to run the CLI directly from PyPI without a permanent install:

uvx aula --username johndoe messages --limit 5

Install from Source

git clone https://github.com/nickknissen/aula.git
cd aula
pip install -e .

Quick Start

import asyncio
from aula import FileTokenStorage
from aula.auth_flow import authenticate_and_create_client

async def main():
    token_storage = FileTokenStorage(".aula_tokens.json")
    async with await authenticate_and_create_client("your_mitid_username", token_storage) as client:
        profile = await client.get_profile()
        print(profile.display_name)
        for child in profile.children:
            overview = await client.get_daily_overview(child.id)

asyncio.run(main())

Key methods on AulaApiClient: get_profile(), get_daily_overview(child_id), get_message_threads(), get_messages_for_thread(thread_id), get_calendar_events(...), get_posts(...), get_groups(...), get_message_folders(...), search(...), update_presence_template(...), update_presence_status(...), get_profile_master_data(...), get_secure_documents(...), get_consent_responses(...), get_auto_reply(), get_vacation_registrations(...), get_notification_settings(), keep_alive(). See src/aula/api_client.py for the full list.

Widget API (Namespace)

Widget integrations are available via the namespaced widgets client on AulaApiClient:

tasks = await client.widgets.get_mu_tasks(
    widget_id="0030",  # WIDGET_MIN_UDDANNELSE_TASKS
    child_filter=["12345"],
    institution_filter=["5678"],
    week="2026-W8",
    session_uuid="guardian-user-id",
)

Use the client.widgets.* namespace for widget calls (for example: get_mu_tasks, get_ugeplan, get_easyiq_weekplan, get_meebook_weekplan, get_momo_courses, get_library_status).

Legacy direct widget methods on AulaApiClient are deprecated and will be removed in a future release. Migrate to client.widgets.<method>(...).

Authentication

What You Need

• MitID username — your MitID username (not your Aula username). Find it at mitid.dk.
• A MitID authenticator — either the MitID app on your phone, or a MitID kodeviser (code display device) plus your MitID password.

Authentication Methods

Pick with --auth-method (or the AULA_AUTH_METHOD env var):

MitID chip and audio code readers (kodeoplæser) are not supported. If your account offers one, it's listed in a warning at -v and the login falls back to whatever else you have.

First Login

On first run you have to approve the login in your MitID app. With the default app method the terminal shows the QR code to scan:

Scan with your MitID app: open it, start the QR scanner, and hold the
camera steady on the code below. The code comes in two halves that take
turns in the same spot, so keep the phone still until the app has read
both. It stays quiet until then, and asks you to approve the login once
it has them.

QR code 1 of 2:
█▀▀▀▀▀▀▀███▀▀▀▀███▀▀▀█▀█▀▀▀▀█▀█▀▀▀▀▀▀▀█
█ █▀▀▀█ █ ██ ▀▄ ███▄ ▀▀▀█▀▄█▀▀█ █▀▀▀█ █
...

The two codes are halves of one value, not two things to choose between. The first half holds for two seconds, then the halves swap every second in the same spot. Nothing happens in the app until it has read both, so keep the phone still rather than moving it away after the first one. Once the app has them, the codes disappear and the app asks you to approve the login.

If your app asks for a code to type instead of a scan, that code is printed instead of the QR code.

Tokens are saved to the storage file and reused on subsequent runs — no authenticator interaction needed until they expire. aula logout removes them and forces a fresh MitID login; the saved MitID username is kept.

For the kodeviser method you can skip the prompts:

export AULA_MITID_PASSWORD='...'      # or --password
aula --auth-method token --token-code 123456 messages

The kodeviser code rotates, so --token-code is only useful for a single run. The password is never written to the config file; supply it per-run or via the environment.

If Login Is Blocked

If you are outside Denmark, the login can be stopped before MitID is reached:

Login blocked: you are most likely not connecting from a Danish IP address.

STIL diverted the redirect to MitID into a security check on
security-check.stil.dk. ...

STIL puts a bot check in front of the UniLogin broker. Getting past it needs a browser that runs JavaScript, so this client cannot complete a login while the check is active.

The check does not fire for everyone. Every report so far comes from outside Denmark: logins from a Danish IP address are let through, while logins from other countries are challenged. If you are outside Denmark, a connection with a Danish IP address is the only known workaround. See issue #43.

Token Security

Tokens provide full access to your Aula account — treat them like passwords and never commit token files to version control.

Application diagnostics redact recognized credential fields and URL query values, and omit raw authentication HTML. This does not anonymize personal content: debug logs can still contain school data and should be reviewed before sharing.

How It Works

For a detailed breakdown of the authentication flow (OAuth + SAML + MitID), session cookies, and how this library differs from the browser login, see docs/aula-authentication.md.

CLI

Install as a standalone tool:

# with uv (recommended)
uv tool install aula

# or with pip
pip install aula

Then run:

aula --username <your_mitid_username> [COMMAND]

The username can also be set via the AULA_MITID_USERNAME environment variable or a config file.

Core

Messages

aula mark-read moves a thread's read marker to its newest message, as the app does when a thread is opened, and checks that Aula took it. The marker targets the newest message found while reading; messages arriving afterward may remain unread. A thread can begin with events (recipients added or removed) that are not messages, so it reads up to 50 pages of 20. Running out of that scan limit raises an error, while a thread that holds only events is returned unmarked and makes the command exit 1. Only threads in your own mailbox are handled; common and OTP inboxes are refused. It tries every thread given and exits with a non-zero code if any was not marked.

For exhaustive reads, use search_messages_result(), get_all_message_threads_result(cutoff_date), or get_all_messages_for_thread_result(thread_id). Each returns PaginationResult with items, complete, and termination_reason. The existing list methods remain available and warn when returning partial results. Records with stable IDs are deduplicated in first-seen order.

Request failures still raise, including on later pages. aula messages --search returns a JSON object containing these three fields instead of a bare list. Incomplete searches print a warning in text mode and exit 1 in both modes. Message image exports report incomplete searches/thread reads through progress messages and an optional on_incomplete callback while preserving their (downloaded, skipped) return tuple. The download CLI includes message_export completeness and issues in JSON, and exits 1 for incomplete message exports.

Calendar

aula meetings --child-id 12345 --start-date 2026-11-01 --end-date 2026-12-01 shows that child's booked parent meetings in November. The end date is exclusive; without --child-id, all children are included. Text times use Europe/Copenhagen. JSON output includes the child, meeting ID, location and exact booked timestamps.

The Python API is await client.get_meeting_bookings(child.id, start, end), with timezone-aware datetime bounds and an exclusive end. It returns MeetingBooking models for actual appointments, excluding unbooked invitations and other children's answers. Long ranges are fetched in chunks; a rejected request raises instead of returning a partial list.

Presence

Content

Image exports keep an .aula-archive.json manifest in the output directory to recognize previously downloaded attachments by source identity. Distinct files with equal names receive separate paths. Keep the manifest with the archive for reruns. Existing files without manifest entries are preserved; the attachment is downloaded beside them because its identity cannot be established from its name.

Widgets

Global flags

JSON output

All commands support --output json for machine-readable output:

aula --output json messages --unread
aula --output json daily-summary --child "Emma"
aula --output json calendar --start-date 2026-03-10

Examples

aula --username johndoe messages --limit 5
# or without installing
uvx aula --username johndoe messages --limit 5

Configuration

~/.config/aula/config.json:

{
  "mitid_username": "your_mitid_username"
}

The username is saved automatically on first login. CLI flags and environment variables take precedence over the config file.

AI Agent Integration

The CLI is designed to work with AI coding agents like Claude Code and OpenCode. The agent-setup command installs a skill that teaches agents how to query Aula for school data.

# Install for the current project
aula agent-setup

# Install globally (all projects)
aula agent-setup --global

This creates a SKILL.md following the Agent Skills open standard under .claude/skills/aula/, which is read by both Claude Code and OpenCode. Once installed, agents can invoke /aula or automatically use the CLI when you ask about school data.

Project Structure

src/aula/
  api_client.py             # Async API client (main entry point)
  cli.py                    # Click CLI commands
  auth_flow.py              # High-level auth orchestration
  config.py                 # CLI config (~/.config/aula/config.json)
  token_storage.py          # Token persistence (ABC + file impl)
  auth/                     # MitID authentication
    mitid_client.py         # 7-step OAuth+SAML+MitID flow
    browser_client.py       # Low-level MitID protocol (QR, OTP, SRP)
    srp.py                  # Secure Remote Password with AES-GCM
  models/                   # API data models (one file per model)
  utils/                    # HTML helpers, table rendering, downloads
tests/                      # Mirrors src/aula/ structure

Attribution

• Aula API usage was inspired by the scaarup/aula Home Assistant integration.
• MitID authentication was inspired by the Hundter/MitID-BrowserClient project.
• EasyIQ widget integration (weekplan and homework) was inspired by the esbenwiberg/easyiq Home Assistant integration.
• Additional API endpoints were discovered via the eisbaw/aulalibre Rust client, which reverse-engineered the Aula Android app.

License

MIT