Skip to main content

codecov

edupsyadmin

edupsyadmin logo

edupsyadmin provides tools to help school psychologists with their documentation

Key Features

  • Secure & Encrypted: Sensitive client data is stored in an encrypted SQLite database using cryptography and keyring for secure credential management.
  • Modern TUI & CLI: Choose between an intuitive Terminal User Interface (TUI) for interactive workflows or a powerful Command Line Interface (CLI) for automation.
  • Automated Documentation: Automatically fill PDF forms and generate reports using stored client data.
  • Data Interoperability: Import student data from common school management software via CSV exports.

Basic Setup

You can install the CLI using pip or uv.

Install with uv:

uv tool install edupsyadmin

You may get a warning that the bin directory is not on your environment path. If that is the case, copy the path from the warning and add it directory to your environment path permanently or just for the current session.

Run the application:

edupsyadmin --help

Quick Start

The fastest way to get started is by using the interactive edupsyadmin TUI:

Edupsyadmin TUI

1. Configure the app

First, you have to update the config file with your data using the config editor TUI:

edupsyadmin edit-config

2. Launch the main interface

Once configured, you can view, add, and edit clients, as well as fill PDF forms directly from the main TUI:

edupsyadmin tui

Getting started

Keyring backend

edupsyadmin uses keyring to store the encryption credentials. keyring has several backends.

  • On Windows the default is the Windows Credential Manager (German: Anmeldeinformationsverwaltung).

  • On macOS, the default is Keychain (German: Schlüsselbund)

Those default keyring backends unlock when you login to your machine. You may want to install a backend that requires separate unlocking: https://keyring.readthedocs.io/en/latest/#third-party-backends

The database

The information you enter, is stored in an SQLite database with the fields described in the documentation for edupsyadmin

Examples

Get information about the path to the config file and the path to the database:

edupsyadmin info

Add a client interactively:

edupsyadmin new-client

Add a client to the database from a Webuntis csv export:

edupsyadmin new-client --csv ./path/to/your/file.csv --name "short_name_of_client"

Change values for the database entry with client_id=42 interactively:

edupsyadmin set-client 42

Change values for the database entry with client_id=42 from the command line:

$ edupsyadmin set-client 42 \
  --key-value-pairs \
  "nta_font=1" \
  "nta_zeitv_vieltext=20" \
  "nos_rs=0" \
  "lrst_diagnosis_encr=iLst"

Delete the database entry with client_id=42:

edupsyadmin delete-client 42

See an overview of all clients in the database:

edupsyadmin get-clients

Fill a PDF form for the database entry with client_id=42:

edupsyadmin create-documentation 42 --form-paths ./path/to/your/file.pdf

Fill all files that belong to the form_set lrst (as defined in the config.yml) for the database entry with client_id=42:

edupsyadmin create-documentation 42 --form-set lrst

Generate a "Tätigkeitsbericht" PDF with 3 Anrechnungsstunden (experimental):

edupsyadmin taetigkeitsbericht 3

Flatten filled PDF forms:

edupsyadmin flatten-pdfs ./path/to/filled_form.pdf

Development

Create the development environment:

uv v
uv pip install -e .

Run the test suite:

.venv/bin/python -m pytest -v -n auto --cov=src test/

Run the benchmarks (set --benchmark-time-unit=s to set the unit to seconds)

.venv/bin/python -m pytest --benchmark-only test/

Build documentation:

.venv/bin/python -m sphinx -M html docs docs/_build

License

This project is licensed under the terms of the MIT License. Portions of this project are derived from the python application project cookiecutter template by Michael Klatt, which is also licensed under the MIT license.

This project also bundles the Liberation Sans font family, which is licensed under the SIL Open Font License, Version 1.1.

See the LICENSE.txt file for details.

Metadata

Release files for edupsyadmin 10.1.0

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

Source distribution (sdist)

Source distribution for edupsyadmin 10.1.0
File Size Uploaded Provenance Actions
edupsyadmin-10.1.0.tar.gz 2.3 MB Without provenance Details for edupsyadmin-10.1.0.tar.gz

Built distribution (wheel)

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

Total release size: 2.9 MB

Release files / edupsyadmin-10.1.0.tar.gz

Download URL edupsyadmin-10.1.0.tar.gz
Size 2.3 MB
Tags Source
SHA-256 checksum
How to use checksums
be59d20a572f6d6f7372366d2d67511b4f0b95f065f79142196cac9174a9d6c1
BLAKE2b-256 checksum
How to use checksums
847ce654656e9f1d5329b34f9b0bf101624c28372f4117383d77d08c1ebcdeab
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / edupsyadmin-10.1.0-py3-none-any.whl

Download URL edupsyadmin-10.1.0-py3-none-any.whl
Size 585.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e9dab51f95ab6b6302fc1020a9c7714efaa2909c4b436b951e1d46a4433d6ecd
BLAKE2b-256 checksum
How to use checksums
f00a1088f00259c1ed36feed045a77a6564041ab5ea051f3dedac89ef1509cf4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for edupsyadmin 10.1.0

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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.

Release history Release notifications | RSS feed

This release

10.1.0 This release

2 release files No provenance

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