edupsyadmin 8.1.4__tar.gz → 8.2.0__tar.gz

{edupsyadmin-8.1.4 → edupsyadmin-8.2.0}/.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.14.11
+  rev: v0.15.2
   hooks:
     - id: ruff-check
       args: [ "--config=pyproject.toml", "--fix" ]
@@ -17,7 +17,7 @@ repos:
   hooks:
     - id: gitleaks
 - repo: https://github.com/commitizen-tools/commitizen
-  rev: v4.11.1
+  rev: v4.13.9
   hooks:
     - id: commitizen
 - repo: https://github.com/rstcheck/rstcheck
@@ -30,3 +30,16 @@ repos:
   hooks:
     - id: sphinx-lint
       args: ["--enable=all"]
+- repo: https://github.com/rvben/rumdl-pre-commit
+  rev: v0.1.28
+  hooks:
+    - id: rumdl-fmt  # Auto-format and fail if issues remain
+- repo: local
+  hooks:
+    - id: ty-check
+      name: ty-check
+      entry: ty check
+      language: python
+      types: [python]
+      args: [--python=.venv/]
+      pass_filenames: true

{edupsyadmin-8.1.4 → edupsyadmin-8.2.0}/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 8.2.0 (2026-03-08)
+
+### Feat
+
+- **db.clients**: add variable case_active to database
+
+## 8.1.5 (2026-03-02)
+
+### Refactor
+
+- **api**: improve session management, metadata caching, and ORM consistency
+- **cli**: deprecate migrate-encryption command
+
 ## 8.1.4 (2026-02-27)
 
 ### Fix

{edupsyadmin-8.1.4 → edupsyadmin-8.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edupsyadmin
-Version: 8.1.4
+Version: 8.2.0
 Summary: edupsyadmin provides tools to help school psychologists with their documentation
 Author: Lukas Liebermann
 License: MIT
@@ -34,6 +34,19 @@ Description-Content-Type: text/markdown
 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
@@ -41,7 +54,9 @@ You can install the CLI using pip or
 
 Install with uv:
 
-    uv tool install edupsyadmin
+```text
+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
@@ -49,11 +64,37 @@ your **environment path** permanently or just for the current session.
 
 Run the application:
 
-    edupsyadmin --help
+```text
+edupsyadmin --help
+```
+
+## Quick Start
+
+The fastest way to get started is by using the interactive **edupsyadmin TUI**:
+
+![Edupsyadmin TUI](test/edupsyadmin/tui/__snapshots__/test_edupsyadmintui/test_edupsyadmintui_initial_layout.svg)
+
+### 1. Configure the app
+
+First, you have to update the config file with your data using the config
+editor TUI:
+
+```text
+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:
+
+```text
+edupsyadmin tui
+```
 
 ## Getting started
 
-### keyring backend
+### Keyring backend
 
 edupsyadmin uses `keyring` to store the encryption credentials. `keyring` has
 several backends.
@@ -67,13 +108,6 @@ 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>
 
-### Modify the config file
-
-First, you have to update the config file with your data using the config
-editor TUI:
-
-    edupsyadmin edit-config
-
 ## The database
 
 The information you enter, is stored in an SQLite database with the fields
@@ -84,23 +118,31 @@ edupsyadmin](https://edupsyadmin.readthedocs.io/en/latest/clients_model.html#)
 
 Get information about the path to the config file and the path to the database:
 
-    edupsyadmin info
+```text
+edupsyadmin info
+```
 
 Add a client interactively:
 
-    edupsyadmin new-client
+```text
+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"
+```text
+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
+```text
+edupsyadmin set-client 42
+```
 
-Change values for the database entry with `client_id=42` from the commandline:
+Change values for the database entry with `client_id=42` from the command line:
 
-```
+```text
 $ edupsyadmin set-client 42 \
   --key_value_pairs \
   "nta_font=1" \
@@ -109,33 +151,63 @@ $ edupsyadmin set-client 42 \
   "lrst_diagnosis_encr=iLst"
 ```
 
+Delete the database entry with `client_id=42`:
+
+```text
+edupsyadmin delete-client 42
+```
+
 See an overview of all clients in the database:
 
-    edupsyadmin get-clients
+```text
+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
+```text
+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) with the data for `client_id=42`:
+config.yml) for the database entry with `client_id=42`:
 
-    edupsyadmin create-documentation 42 --form_set lrst
+```text
+edupsyadmin create-documentation 42 --form_set lrst
+```
+
+Generate a "Tätigkeitsbericht" PDF with 3 Anrechnungsstunden (experimental):
+
+```text
+edupsyadmin taetigkeitsbericht 3
+```
+
+Flatten filled PDF forms (experimental):
+
+```text
+edupsyadmin flatten-pdfs ./path/to/filled_form.pdf
+```
 
 ## Development
 
-Create the development enviroment:
+Create the development environment:
 
-    uv v
-    uv pip install -e .
+```text
+uv v
+uv pip install -e .
+```
 
 Run the test suite:
 
-    .venv/bin/python -m pytest -v -n auto --cov=src test/
+```text
+.venv/bin/python -m pytest -v -n auto --cov=src test/
+```
 
 Build documentation:
 
-    .venv/bin/python -m sphinx -M html docs docs/_build
+```text
+.venv/bin/python -m sphinx -M html docs docs/_build
+```
 
 ## License
 

{edupsyadmin-8.1.4 → edupsyadmin-8.2.0}/README.md

@@ -3,6 +3,19 @@
 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
@@ -10,7 +23,9 @@ You can install the CLI using pip or
 
 Install with uv:
 
-    uv tool install edupsyadmin
+```text
+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
@@ -18,11 +33,37 @@ your **environment path** permanently or just for the current session.
 
 Run the application:
 
-    edupsyadmin --help
+```text
+edupsyadmin --help
+```
+
+## Quick Start
+
+The fastest way to get started is by using the interactive **edupsyadmin TUI**:
+
+![Edupsyadmin TUI](test/edupsyadmin/tui/__snapshots__/test_edupsyadmintui/test_edupsyadmintui_initial_layout.svg)
+
+### 1. Configure the app
+
+First, you have to update the config file with your data using the config
+editor TUI:
+
+```text
+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:
+
+```text
+edupsyadmin tui
+```
 
 ## Getting started
 
-### keyring backend
+### Keyring backend
 
 edupsyadmin uses `keyring` to store the encryption credentials. `keyring` has
 several backends.
@@ -36,13 +77,6 @@ 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>
 
-### Modify the config file
-
-First, you have to update the config file with your data using the config
-editor TUI:
-
-    edupsyadmin edit-config
-
 ## The database
 
 The information you enter, is stored in an SQLite database with the fields
@@ -53,23 +87,31 @@ edupsyadmin](https://edupsyadmin.readthedocs.io/en/latest/clients_model.html#)
 
 Get information about the path to the config file and the path to the database:
 
-    edupsyadmin info
+```text
+edupsyadmin info
+```
 
 Add a client interactively:
 
-    edupsyadmin new-client
+```text
+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"
+```text
+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
+```text
+edupsyadmin set-client 42
+```
 
-Change values for the database entry with `client_id=42` from the commandline:
+Change values for the database entry with `client_id=42` from the command line:
 
-```
+```text
 $ edupsyadmin set-client 42 \
   --key_value_pairs \
   "nta_font=1" \
@@ -78,33 +120,63 @@ $ edupsyadmin set-client 42 \
   "lrst_diagnosis_encr=iLst"
 ```
 
+Delete the database entry with `client_id=42`:
+
+```text
+edupsyadmin delete-client 42
+```
+
 See an overview of all clients in the database:
 
-    edupsyadmin get-clients
+```text
+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
+```text
+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) with the data for `client_id=42`:
+config.yml) for the database entry with `client_id=42`:
 
-    edupsyadmin create-documentation 42 --form_set lrst
+```text
+edupsyadmin create-documentation 42 --form_set lrst
+```
+
+Generate a "Tätigkeitsbericht" PDF with 3 Anrechnungsstunden (experimental):
+
+```text
+edupsyadmin taetigkeitsbericht 3
+```
+
+Flatten filled PDF forms (experimental):
+
+```text
+edupsyadmin flatten-pdfs ./path/to/filled_form.pdf
+```
 
 ## Development
 
-Create the development enviroment:
+Create the development environment:
 
-    uv v
-    uv pip install -e .
+```text
+uv v
+uv pip install -e .
+```
 
 Run the test suite:
 
-    .venv/bin/python -m pytest -v -n auto --cov=src test/
+```text
+.venv/bin/python -m pytest -v -n auto --cov=src test/
+```
 
 Build documentation:
 
-    .venv/bin/python -m sphinx -M html docs docs/_build
+```text
+.venv/bin/python -m sphinx -M html docs docs/_build
+```
 
 ## License
 

{edupsyadmin-8.1.4 → edupsyadmin-8.2.0}/docs/tutorial/helpfunction.rst

@@ -45,7 +45,7 @@ anzeigen. Im Beispiel unten, sind die möglichen Unterbefehle markiert.
         flatten-pdfs        Flatten pdf forms (experimental)
         get-clients         Show clients overview or single client
         info                Get useful information for debugging
-        migrate-encryption  Migrate database to new encryption system
+        migrate-encryption  [DEPRECATED] Migrate database to new encryption system
         mk-report           Create a report for a given test type. (experimental)
         new-client          Add a new client
         set-client          Change values for one or more clients

{edupsyadmin-8.1.4 → edupsyadmin-8.2.0}/docs/tutorial/update.rst

@@ -45,6 +45,12 @@ mit ``edupsyadmin version``, ``database_url``, ``config_path`` und
 die ``database_url`` notieren, damit du das Backup später findest, wenn du es
 löschen willst.
 
+.. warning::
+
+    Der Befehl ``edupsyadmin migrate-encryption`` wird mit Version 9.0.0
+    entfernt. Wenn du noch eine Datenbank aus Version 7 nutzt, führe die
+    Migration auf das neue Verschlüsselungssystem zeitnah durch.
+
 Update der App
 --------------
 

{edupsyadmin-8.1.4 → edupsyadmin-8.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "edupsyadmin"
-version = "8.1.4"
+version = "8.2.0"
 authors = [{ name = "Lukas Liebermann" }]
 description = "edupsyadmin provides tools to help school psychologists with their documentation"
 readme = "README.md"
@@ -42,7 +42,6 @@ bwbackend = ["bitwarden-keyring>=0.3.1"]
 [dependency-groups]
 dev = [
   "commitizen>=3.31.0",
-  "mypy>=1.13.0",
   "pandas-stubs>=2.2.3.241009",
   "pytest-cov>=6.0.0",
   "pytest>=8.3.3",
@@ -62,6 +61,8 @@ dev = [
   "pytest-textual-snapshot>=1.1.0",
   "pytest-benchmark>=5.2.0",
   "sphinx-design>=0.6.1",
+  "pre-commit>=4.5.1",
+  "ty>=0.0.20",
 ]
 
 [tool.hatch.build.targets.wheel]
@@ -124,4 +125,7 @@ omit = [
 ignore_directives = ["tab-set", "dropdown", "automodule", "autoclass"]
 
 [tool.uv]
-exclude-newer = "1 week"
+exclude-newer = "3d"
+
+[tool.rumdl]
+exclude = ["CHANGELOG.md"]

{edupsyadmin-8.1.4 → edupsyadmin-8.2.0}/src/edupsyadmin/__version__.py

@@ -18,4 +18,4 @@ and backwards compatibility is not guaranteed for minor versions.
 
 __all__ = ["__version__"]
 
-__version__ = "8.1.4"
+__version__ = "8.2.0"

edupsyadmin-8.2.0/src/edupsyadmin/alembic/versions/2026_03_02_1222-635a9d68fbe8_add_case_active_column_to_clients.py

@@ -0,0 +1,30 @@
+"""add case_active column to clients
+
+Revision ID: 635a9d68fbe8
+Revises: 4087c43f0c7c
+Create Date: 2026-03-02 12:22:07.136023
+
+"""
+
+from collections.abc import Sequence
+
+import sqlalchemy as sa
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "635a9d68fbe8"
+down_revision: str | None = "4087c43f0c7c"
+branch_labels: str | Sequence[str] | None = None
+depends_on: str | Sequence[str] | None = None
+
+
+def upgrade() -> None:
+    op.add_column(
+        "clients",
+        sa.Column("case_active", sa.Boolean(), nullable=False, server_default="1"),
+    )
+
+
+def downgrade() -> None:
+    op.drop_column("clients", "case_active")

{edupsyadmin-8.1.4 → edupsyadmin-8.2.0}/src/edupsyadmin/api/managers.py

@@ -31,14 +31,22 @@ class ClientsManager:
         self.engine = create_engine(database_url, echo=False)
         self.Session = sessionmaker(bind=self.engine)
 
+        # Cache mapper and column metadata
+        self._mapper = inspect(clients_db.Client)
+        self._colmap = {
+            col.key: getattr(clients_db.Client, col.key) for col in self._mapper.columns
+        }
+        self._valid_keys = {c.key for c in self._mapper.column_attrs}
+
         logger.debug(f"created connection to database at {database_url}")
 
     def add_client(self, **client_data: Any) -> int:
         logger.debug("trying to add client")
         with self.Session() as session:
-            new_client = clients_db.Client(**client_data)
-            session.add(new_client)
-            session.commit()
+            with session.begin():
+                new_client = clients_db.Client(**client_data)
+                session.add(new_client)
+            # Accessing client_id after commit (end of begin block)
             logger.info(f"added client: {new_client}")
             return new_client.client_id
 
@@ -48,9 +56,8 @@ class ClientsManager:
             client = session.get(clients_db.Client, client_id)
             if client is None:
                 raise ClientNotFoundError(client_id)
-            # Create a clean dictionary using the ORM mapper
-            mapper = inspect(client.__class__)
-            return {c.key: getattr(client, c.key) for c in mapper.column_attrs}
+            # Create a clean dictionary using the cached mapper
+            return {c.key: getattr(client, c.key) for c in self._mapper.column_attrs}
 
     def get_clients_overview(
         self,
@@ -78,18 +85,12 @@ class ClientsManager:
             "keyword_taet_encr",
         ]
 
-        # Map ORM/DB keys to column expressions
-        mapper = inspect(clients_db.Client)
-        colmap = {
-            col.key: getattr(clients_db.Client, col.key) for col in mapper.columns
-        }
-
         extras = default_extras if columns is None else columns
 
         # Validate extras against available columns
-        invalid = set(extras) - set(colmap.keys())
+        invalid = set(extras) - set(self._colmap.keys())
         if invalid:
-            allowed = ", ".join(sorted(colmap.keys()))
+            allowed = ", ".join(sorted(self._colmap.keys()))
             raise ValueError(
                 f"Invalid column names: {', '.join(sorted(invalid))}. "
                 f"Allowed: {allowed}"
@@ -99,7 +100,7 @@ class ClientsManager:
         final_columns = list(dict.fromkeys(required_columns + extras))
 
         # Build SELECT
-        selected_cols = [colmap[name].label(name) for name in final_columns]
+        selected_cols = [self._colmap[name].label(name) for name in final_columns]
         stmt = select(*selected_cols)
 
         # Optional filters
@@ -122,23 +123,27 @@ class ClientsManager:
 
     def get_all_clients_df(self) -> pd.DataFrame:
         """
-        Get the entire database as a pandas DataFrame.
-        Note: This returns DECRYPTED data.
+        Get the entire database as a pandas DataFrame via ORM to ensure decryption.
         """
-        logger.debug("trying to query the entire database")
-        stmt = select(clients_db.Client)
-        return pd.read_sql_query(stmt, self.engine)
+        logger.debug("querying entire database via ORM")
+        with self.Session() as session:
+            stmt = select(clients_db.Client)
+            clients = session.scalars(stmt).all()
+            data = [
+                {c.key: getattr(client, c.key) for c in self._mapper.column_attrs}
+                for client in clients
+            ]
+            return pd.DataFrame(data)
 
     def edit_client(self, client_ids: list[int], new_data: dict[str, Any]) -> None:
         logger.debug(f"editing clients (ids = {client_ids})")
 
         # Validate keys
-        valid_keys = {c.key for c in inspect(clients_db.Client).column_attrs}
-        invalid_keys = set(new_data.keys()) - valid_keys
+        invalid_keys = set(new_data.keys()) - self._valid_keys
         if invalid_keys:
             raise ValueError(f"Invalid keys found: {', '.join(invalid_keys)}")
 
-        with self.Session() as session:
+        with self.Session() as session, session.begin():
             stmt = select(clients_db.Client).where(
                 clients_db.Client.client_id.in_(client_ids)
             )
@@ -160,12 +165,10 @@ class ClientsManager:
                     setattr(client, key, value)
                 client.datetime_lastmodified = datetime.now()
 
-            session.commit()
-
     def delete_client(self, client_id: int) -> None:
-        logger.debug("deleting client")
-        with self.Session() as session:
+        logger.debug(f"deleting client {client_id}")
+        with self.Session() as session, session.begin():
             client = session.get(clients_db.Client, client_id)
-            if client:
-                session.delete(client)
-                session.commit()
+            if not client:
+                raise ClientNotFoundError(client_id)
+            session.delete(client)