edupsyadmin 8.2.0__tar.gz → 9.0.0__tar.gz

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

@@ -6,18 +6,20 @@ repos:
     -   id: check-yaml
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
+    -   id: mixed-line-ending
+        args: ['--fix=lf']
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.15.2
+  rev: v0.15.12
   hooks:
     - id: ruff-check
       args: [ "--config=pyproject.toml", "--fix" ]
     - id: ruff-format
 - repo: https://github.com/gitleaks/gitleaks
-  rev: v8.30.0
+  rev: v8.30.1
   hooks:
     - id: gitleaks
 - repo: https://github.com/commitizen-tools/commitizen
-  rev: v4.13.9
+  rev: v4.15.0
   hooks:
     - id: commitizen
 - repo: https://github.com/rstcheck/rstcheck
@@ -31,7 +33,7 @@ repos:
     - id: sphinx-lint
       args: ["--enable=all"]
 - repo: https://github.com/rvben/rumdl-pre-commit
-  rev: v0.1.28
+  rev: v0.1.87
   hooks:
     - id: rumdl-fmt  # Auto-format and fail if issues remain
 - repo: local
@@ -43,3 +45,11 @@ repos:
       types: [python]
       args: [--python=.venv/]
       pass_filenames: true
+- repo: https://github.com/tox-dev/pyproject-fmt
+  rev: "v2.21.1"
+  hooks:
+    - id: pyproject-fmt
+- repo: https://github.com/dosisod/refurb
+  rev: "v2.3.1"
+  hooks:
+    - id: refurb

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

@@ -1,3 +1,90 @@
+## 9.0.0 (2026-05-04)
+
+### Feat
+
+- **api.flatten_pdf**: add a pypdf flattening implementation that works with checkboxes, multiline text input and radio buttons
+
+### Fix
+
+- **cli**: do not access keyring for flatten-pdfs
+- **api.flattening.flatten_pypdf**: improve field attribute resolution and resource cloning
+- **api.flattening.flatten_pypdf**: convert non-ASCII characters into octal escapes for flattening
+- **api.flattening**: fix issue with type checks and with lazy import
+- **config**: resolve LGVT configuration type errors
+
+### Refactor
+
+- **api**: replace dataframe_image with native ReportLab tables
+- **api**: improve PDF reports and Tätigkeitsbericht report type safety
+- **api.fill_form**: refactor for better readability
+- **api.add_convenience_data**: remove unnecessary casts and simplify date conversions
+- **db.clients**: extract gender validation and class int extraction into functions
+- **db**: move custom types and converters out of clients.py
+- refactor: consolidate batch form-filling logic and improve TUI reporting
+
+## 9.0.0a0 (2026-04-16)
+
+### BREAKING CHANGE
+
+- Form field names need to change, for example: birthday_encr_de > birthday_de and lrst_last_test_date_encr_de > lrst_last_test_date_de
+
+### Feat
+
+- **api.add_convenience_data**: mark changing the _add_dates function change in 9fb38da as breaking change
+- add configurable template and output directories
+- log number of entries in database before get_clients and tui
+- **api**: replace pyfpdf with reportlab and unify report output code
+- **api.fill_form**: add aliases for encrypted fields during form filling
+- **db.clients**: encrypt nta and nos string fields
+- **info**: show the backup path in info
+- migrate to version-less stable paths for config and data
+- move encryption salt to database metadata
+- encrypt all client date fields and standardize presentation
+- encrypt class_name and class_int columns
+
+### Fix
+
+- **db.clients**: set encrypted text fields to non-nullable in clients model
+- **api.setup_demo**: use the same school as in sampleconfig.yml to prevent tui crash
+- **api.migration**: ensure database migrations respect custom salt and encryption is ready for migrations
+- **alembic**: support custom paths in salt migration
+- **alembic**: modify migrations to handle NULL values more robustly
+- **api.migration**: stamp legacy databases correctly with the initial migration
+- secure database schema by enforcing NOT NULL on encrypted columns
+- standardise encrypted field types and null handling
+- **cli**: scrub sensitive data from logs
+
+### Refactor
+
+- **api.flatten_pdf**: refactor for readability and easier testing
+- make the code more pythonic
+- **tui.editconfig**: split application logic from the UI component definitions
+- **tui.editconfig**: refactor for readability
+- **tui**: remove duplicate code and standardize name of ctrl+q binding
+- **api.managers**: allow single column strings as an argument to get_clients_overview
+- **api.fill_form**: refactor fill_form for readability
+- **core.logger**: update type hints to reflect recent changes
+- replace hardcoded srings with StrEnum for type safety
+- **core.logger**: properly register custom Logger class
+- **db.clients**: remove validators that did nothing
+- **py.typed**: move py.typed to the intended location
+- add some new pre-commit hooks and fix issues the hooks raise
+- **api.managers**: consolidate client data retrieval
+- **api.managers**: optimize get_all_clients_df using sqlalchemy core
+- **api.managers**: remove redundant code
+- **taetigkeitsbericht_from_db**: query only required columns
+- remove deprecated v7 to v8 encryption migration command
+
+### Perf
+
+- **api.migration**: only create db backup when a migration is required
+
+## 8.2.1 (2026-03-08)
+
+### Refactor
+
+- add ClientData TypedDict and enhance type hinting
+
 ## 8.2.0 (2026-03-08)
 
 ### Feat

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

@@ -1,32 +1,38 @@
 Metadata-Version: 2.4
 Name: edupsyadmin
-Version: 8.2.0
+Version: 9.0.0
 Summary: edupsyadmin provides tools to help school psychologists with their documentation
+Project-URL: documentation, https://edupsyadmin.readthedocs.io
+Project-URL: homepage, https://github.com/LKirst/edupsyadmin.git
 Author: Lukas Liebermann
 License: MIT
 License-File: LICENSE.txt
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.14
 Requires-Dist: alembic>=1.14.1
 Requires-Dist: cryptography>=43.0.3
 Requires-Dist: fillpdf>=0.7.3
-Requires-Dist: keyring>=25.5.0
+Requires-Dist: keyring>=25.5
 Requires-Dist: pandas>=2.2.3
 Requires-Dist: platformdirs>=4.3.6
 Requires-Dist: pydantic>=2.12.3
-Requires-Dist: pypdf>=5.1.0
+Requires-Dist: pypdf>=5.1
+Requires-Dist: python-dateutil>=2.9.0.post0
 Requires-Dist: python-liquid>=1.12.1
 Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: rich>=14.3.3
 Requires-Dist: scipy>=1.14.1
 Requires-Dist: sqlalchemy>=2.0.36
-Requires-Dist: textual>=8.0.0
+Requires-Dist: textual>=8
 Provides-Extra: bwbackend
 Requires-Dist: bitwarden-keyring>=0.3.1; extra == 'bwbackend'
 Provides-Extra: flattenpdf
-Requires-Dist: pdf2image>=1.17.0; extra == 'flattenpdf'
+Requires-Dist: pdf2image>=1.17; extra == 'flattenpdf'
 Provides-Extra: reportsandtaetigkeitsber
-Requires-Dist: dataframe-image>=0.2.6; extra == 'reportsandtaetigkeitsber'
-Requires-Dist: fpdf2>=2.8.3; extra == 'reportsandtaetigkeitsber'
 Requires-Dist: matplotlib>=3.9.2; extra == 'reportsandtaetigkeitsber'
+Requires-Dist: numpy>=2.4.4; extra == 'reportsandtaetigkeitsber'
+Requires-Dist: reportlab>=4.2.5; extra == 'reportsandtaetigkeitsber'
 Description-Content-Type: text/markdown
 
 # edupsyadmin
@@ -203,6 +209,12 @@ 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)
+
+```text
+.venv/bin/python -m pytest --benchmark-only test/
+```
+
 Build documentation:
 
 ```text

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

@@ -172,6 +172,12 @@ 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)
+
+```text
+.venv/bin/python -m pytest --benchmark-only test/
+```
+
 Build documentation:
 
 ```text

{edupsyadmin-8.2.0 → edupsyadmin-9.0.0}/docs/faq.rst

@@ -23,18 +23,17 @@ Wie greife ich auf Backups zu?
 
 Rufe ``edupsyadmin`` in dem Ordner auf, in dem das Backup liegt.
 Mit dem Befehl ``ls`` kannst du überprüfen, ob in dem Ordner in dem du
-``edupsyadmin`` aufrufst, ``salt.txt``, ``edupsyadmin.db`` und
+``edupsyadmin`` aufrufst, ``edupsyadmin.db`` und
 ``config.yml`` liegen. Wenn nicht, bist du vielleicht im falschen Ordner
 und musst mit ``cd "pfad/deiner/sicherung/"`` noch an die richtige Stelle
 in deinem Dateisystem gehen.
 
 Damit ``edupsyadmin`` nicht die aktuellen Dateien, sondern das Backup
-verwendet, musst du auf die Dateien (Salt, Datenbank und Konfigurationsdatei)
+verwendet, musst du auf die Dateien (Datenbank und Konfigurationsdatei)
 verweisen in jedem Befehl. Hier ist zum Beispiel der Befehl, um die Klienten
 in der Datenbank anzuzeigen (``get-clients``):
 
 .. code-block:: console
 
     $ edupsyadmin --config_path "./config.yml" get-clients \
-        --salt_path "./salt.txt" \
         --database_url "sqlite:///edupsyadmin.db"

{edupsyadmin-8.2.0 → edupsyadmin-9.0.0}/docs/tutorial/cli.rst

@@ -151,6 +151,26 @@ Löscht einen (oder mehrere) Klienten unwiderruflich aus der Datenbank.
 
     $ edupsyadmin delete-client 1 2
 
+Verschlüsselung aktualisieren (``rotate-key``)
+----------------------------------------------
+
+Wenn du dein Passwort in der Konfiguration (``edit-config``) geändert hast,
+werden neue Daten mit dem neuen Passwort verschlüsselt. Bestehende Daten
+bleiben mit dem alten Passwort verschlüsselt, aber weiterhin lesbar.
+
+Mit dem Befehl ``rotate-key`` kannst du alle Daten in der Datenbank
+vollständig auf das aktuellste Passwort umstellen. Dies ist eine gute
+Sicherheitspraxis.
+
+.. code-block:: console
+
+    $ edupsyadmin rotate-key
+
+Nach der Re-Verschlüsselung wirst du gefragt, ob alte, nun nicht mehr
+benötigte Schlüssel aus deinem Schlüsselspeicher (Keyring) gelöscht werden
+sollen. Wenn du dies bestätigst, wird nur noch dein aktuelles Passwort
+benötigt, um auf alle Daten zuzugreifen.
+
 PDF-Formulare für den Druck vorbereiten (``flatten-pdfs``)
 ----------------------------------------------------------
 

{edupsyadmin-8.2.0 → edupsyadmin-9.0.0}/docs/tutorial/configuration.rst

@@ -4,12 +4,44 @@ Konfiguration
 Nach der Installation ist der nächste Schritt die Konfiguration von
 ``edupsyadmin``.
 
-Die Konfiguration wird in einer Textdatei (YAML-Format) gespeichert. Darin
-stehen wichtige Einstellungen wie deine Schulen oder Vorlagen-Sets.
-Standardmäßig liegt diese Datei unter ``~/.config/edupsyadmin/config.yml``.
+Die Konfiguration wird in einer Textdatei (im YAML-Format, einem einfachen
+Textformat für Einstellungen) gespeichert. Darin stehen wichtige Einstellungen
+wie deine Schulen oder Vorlagen-Sets. Standardmäßig liegt diese Datei unter
+``~/.config/edupsyadmin/config.yml``.
+
+.. tip::
+   **Pfade zu Ordnern und Dateien kopieren**
+
+   In dieser Konfiguration musst du mehrfach Pfade zu Ordnern oder Dateien
+   angeben. So kopierst du einen Pfad:
+
+   .. tab-set::
+
+      .. tab-item:: Windows
+
+         #. Rechtsklick auf die Datei oder den Ordner im Explorer
+         #. Wähle "Als Pfad kopieren"
+         #. Der Pfad wird mit Anführungszeichen kopiert – diese kannst du
+            beim Einfügen entfernen
+
+      .. tab-item:: macOS
+
+         #. Rechtsklick auf den Ordner oder die Datei im Finder
+         #. Halte die :kbd:`Alt`-Taste (⌥) gedrückt
+         #. Wähle "... als Pfadname kopieren"
+
+      .. tab-item:: Linux
+
+         #. Rechtsklick auf den Ordner oder die Datei im Dateimanager
+         #. Wähle "Pfad kopieren" oder "Adresse kopieren"
+            (je nach Dateimanager)
+
+         *Hinweis: Die genaue Bezeichnung kann je nach verwendetem
+         Dateimanager variieren.*
+
 
 Wir müssen diese Datei aber nicht von Hand bearbeiten. Starte einfach die
-Konfigurations-TUI mit diesem Befehl:
+Konfigurations-Oberfläche (Text User Interface, kurz TUI) mit diesem Befehl:
 
 .. code-block:: console
 
@@ -17,7 +49,7 @@ Konfigurations-TUI mit diesem Befehl:
 
 Die Oberfläche, die du jetzt siehst, sollte so aussehen:
 
-.. image:: ../../test/edupsyadmin/tui/__snapshots__/test_editconfig/test_initial_layout.svg
+.. image:: ../../test/edupsyadmin/tui/__snapshots__/test_editconfig/test_editconfig_initial_layout.svg
    :alt: Konfiguration in der TUI bearbeiten
    :width: 100%
    :align: center
@@ -32,13 +64,24 @@ Gehen wir die Felder nun Schritt für Schritt durch:
 #.  **Benutzername**: Ersetze den Platzhalternutzername ``sample.username``
     durch deinen eigenen Benutzernamen. Wähle etwas Kurzes ohne Leerzeichen
     oder Sonderzeichen.
-#.  **Passwort**: Lege hier *einmalig* ein sicheres Passwort für die
-    Verschlüsselung fest.
+#.  **template_directory**: Pfad zum Ordner, in dem du die leeren
+    Formular-Vorlagen abgelegt hast (siehe Tipp oben zum Kopieren von Pfaden).
+#.  **output_directory** (optional): Ordner, in dem ausgefüllte Formulare
+    standardmäßig gespeichert werden sollen (siehe Tipp oben zum Kopieren von
+    Pfaden).
+
+**Passwort**
+
+Lege hier ein sicheres Passwort für die Verschlüsselung fest.
+
 
-    .. warning::
-       Ändere dieses Passwort später nicht mehr, wenn du bereits Daten in
-       der Datenbank hast! Sonst können die Daten nicht mehr entschlüsselt
-       werden.
+.. tip::
+   Du kannst dieses Passwort später jederzeit ändern. ``edupsyadmin``
+   unterstützt Schlüssel-Rotation, sodass bestehende Daten weiterhin
+   entschlüsselt werden können. Wenn du dein Passwort änderst, empfiehlt
+   es sich jedoch, anschließend den Befehl ``edupsyadmin rotate-key``
+   auszuführen, um alle Daten in der Datenbank auf das neue Passwort
+   zu migrieren.
 
 **Schulpsychologie-Einstellungen**
 
@@ -73,10 +116,9 @@ bestehenden Beispiel-Formularsätze und lege ein neues an:
     - `sample_form_mantelbogen.pdf`_
     - `sample_form_stellungnahme.pdf`_
 
-#.  **Pfade kopieren**: Klicke im Datei-Explorer mit der rechten Maustaste auf
-    eine der heruntergeladenen Dateien und wähle "Als Pfad kopieren". Füge
-    diesen Pfad in ein Feld unter deinem ``lrst`` Set ein. Wiederhole das für
-    die zweite Datei.
+#.  **Pfade eintragen**: Kopiere den Pfad zur ersten heruntergeladenen Datei
+    (siehe Tipp oben). Füge diesen Pfad in ein Feld unter deinem ``lrst``
+    Set ein. Wiederhole das für die zweite Datei.
 
 Abschließend klicke auf **Speichern**, um die Konfiguration zu sichern.
 

{edupsyadmin-8.2.0 → edupsyadmin-9.0.0}/docs/tutorial/creatingdocumentation.rst

@@ -13,7 +13,7 @@ Ablauf
 #.  **Dialog öffnen**: Drücke das Tastenkürzel :kbd:`Strg+f`. Es öffnet sich der
     Dialog "Formulare ausfüllen".
 
-    .. image:: ../../test/edupsyadmin/tui/__snapshots__/test_fill_form_tui/test_initial_layout.svg
+    .. image:: ../../test/edupsyadmin/tui/__snapshots__/test_fill_form_tui/test_fill_form_initial_layout.svg
        :alt: Dialog zum Ausfüllen von Formularen
 
 #.  **Formulare auswählen**: In diesem Dialog hast du zwei Möglichkeiten,
@@ -51,7 +51,7 @@ exportiert:
 
 #. Ein Textfeld hinzugen für den Vornamen mit dem Feldnamen ``first_name_encr``.
 
-#. Ein Textfeld hinzufügen für das Geburtsdatum: ``birthday_encr``.
+#. Ein Textfeld hinzufügen für das Geburtsdatum: ``birthday_de``.
 
 #. Über Datei - Expoertieren als - Als PDF exportieren ... die Datei als PDF
    exportieren. In dem Fenster das sich öffnet, die Option aktivieren
@@ -65,4 +65,4 @@ Variable in doppelten geschwungenen Klammern:
    # Protokoll
 
    **Name**: {{ last_name_encr }}, {{ first_name_encr }}
-   **Geboren am**: {{ birthday_encr }}
+   **Geboren am**: {{ birthday_de }}

{edupsyadmin-8.2.0 → edupsyadmin-9.0.0}/docs/tutorial/encryption.rst

@@ -41,11 +41,12 @@ die Sitzung entschlüsselt wird. Dafür musst du:
 
 - ein Bitwarden-Konto anlegen: `<https://bitwarden.com>`_
 - die Bitwarden CLI installieren: `<https://bitwarden.com/help/cli/>`_
-- edupsyadmin mit dem optionalen Paket bitwarden-keyring installieren:
+- edupsyadmin mit der optionalen Abhängigkeit (Extra) ``bwbackend``
+  installieren:
 
 .. code-block :: console
 
-  uv tool install --with bitwarden-keyring edupsyadmin
+  uv tool install edupsyadmin[bwbackend] --python 3.14
 
 - dich einmalig in der Shell (z.B. Powershell über das Windows Terminal)
   einloggen:

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

@@ -29,7 +29,7 @@ anzeigen. Im Beispiel unten, sind die möglichen Unterbefehle markiert.
 
     $ edupsyadmin --help
     usage: edupsyadmin [-h] [-v] [-w WARN]
-                   {create-documentation,delete-client,edit-config,flatten-pdfs,get-clients,info,migrate-encryption,mk-report,new-client,set-client,setup-demo,taetigkeitsbericht,tui} ...
+                   {create-documentation,delete-client,edit-config,flatten-pdfs,get-clients,info,mk-report,new-client,set-client,setup-demo,taetigkeitsbericht,tui} ...
 
     options:
       -h, --help            show this help message and exit
@@ -37,7 +37,7 @@ anzeigen. Im Beispiel unten, sind die möglichen Unterbefehle markiert.
       -w, --warn WARN       logger warning level [WARN]
 
     subcommands:
-      {create-documentation,delete-client,edit-config,flatten-pdfs,get-clients,info,migrate-encryption,mk-report,new-client,set-client,setup-demo,taetigkeitsbericht,tui}
+      {create-documentation,delete-client,edit-config,flatten-pdfs,get-clients,info,mk-report,new-client,set-client,setup-demo,taetigkeitsbericht,tui}
         create-documentation
                             Fill a pdf form or a text file with a liquid template
         delete-client       Delete a client in the database
@@ -45,8 +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  [DEPRECATED] Migrate database to new encryption system
-        mk-report           Create a report for a given test type. (experimental)
+        mk-report           Create a report for a given test type.
         new-client          Add a new client
         set-client          Change values for one or more clients
         setup-demo          Create a sandboxed demo environment.

{edupsyadmin-8.2.0 → edupsyadmin-9.0.0}/docs/tutorial/installation.rst

@@ -177,8 +177,15 @@ benötigen zusätzliche Programme, die nicht automatisch mitinstalliert werden.
 Poppler (für ``flatten-pdfs``)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Die Funktion ``flatten-pdfs`` mit der ``pdf2image`` Bibliothek benötigt
-**Poppler**.
+Die Funktion ``flatten-pdfs`` benötigt das Programm **Poppler** und die
+Python-Bibliothek ``pdf2image``. Letztere wird über die optionale Abhängigkeit
+(Extra) ``flattenpdf`` installiert.
+
+.. code-block:: console
+
+    $ uv tool upgrade edupsyadmin --with flattenpdf
+
+Zur Installation von Poppler:
 
 .. tab-set::
     :sync-group: installation-os
@@ -207,6 +214,18 @@ Die Funktion ``flatten-pdfs`` mit der ``pdf2image`` Bibliothek benötigt
         `poppler-tools` je nach Distribution.
 
 
+Berichte und Tätigkeitsbericht (für ``mk-report`` und ``taetigkeitsbericht``)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Um grafische Berichte und den Tätigkeitsbericht als PDF zu erstellen, müssen
+zusätzliche Bibliotheken installiert werden. Dies geschieht über die optionale
+Abhängigkeit (Extra) ``reportsandtaetigkeitsber``:
+
+.. code-block:: console
+
+    $ uv tool upgrade edupsyadmin --with reportsandtaetigkeitsber
+
+
 Verschlüsselung
 ---------------
 

{edupsyadmin-8.2.0 → edupsyadmin-9.0.0}/docs/tutorial/tui.rst

@@ -16,7 +16,9 @@ aus:
 
 Wie du siehst, ist die TUI in zwei Hauptbereiche unterteilt:
 
-- **Links**: Eine Übersichtstabelle aller Klienten in der Datenbank.
+- **Links**: Eine Übersichtstabelle aller Klienten in der Datenbank. Die Farbe
+  der ``client_id`` signalisiert dabei den Status des Falls (``case_active``):
+  Grün steht für einen aktiven Fall, Rot für einen abgeschlossenen Fall.
 - **Rechts**: Ein Formular zur Anzeige und Bearbeitung der Daten des
   ausgewählten Klienten.
 
@@ -39,7 +41,7 @@ angehören:
 
 Zusätzlich können die angezeigten Spalten mit ``--columns`` angepasst werden.
 Eine Auswahl an Spalten wird immer angezeigt (``client_id``, ``school``,
-``last_name_encr``, ``first_name_encr``, ``class_name``). Mit ``--columns``
+``last_name_encr``, ``first_name_encr``, ``class_name_encr``). Mit ``--columns``
 können weitere Spalten hinzugefügt werden.
 
 Folgender Befehl zeigt zusätzlich die Spalte für ``notes_encr`` und
@@ -98,7 +100,7 @@ sortiert werden:
    * - :kbd:`s`
      - Schule (``school``) und dann Nachname
    * - :kbd:`c`
-     - Klasse (``class_name``) und dann Nachname
+     - Klasse (``class_name_encr``) und dann Nachname
 
 Nächste Schritte
 ----------------

edupsyadmin-9.0.0/docs/tutorial/update.rst

@@ -0,0 +1,77 @@
+Update
+======
+
+.. caution::
+
+    Wenn du mit einem bestehenden Datensatz updatest, informiere dich
+    vorher, ob von deiner Version auf die neue Version sogenannte "breaking
+    changes" durchgeführt wurden, d.h. Änderungen, die zu Inkompatibilitäten
+    von deiner Datenbank zur neuen Version der App führen.
+
+    Ein verlässlicher Hinweis dafür, dass keine breaking changes durchgeführt
+    wurden und einem Update mit Migration der Daten nichts im Wege steht, ist
+    dass sich die erste Ziffer in der Version nicht von der installierten auf
+    die neue Version geändert hat. Das kannst du auf `PYPI
+    <https://pypi.org/project/edupsyadmin/#history>`_ prüfen.
+
+Um keine Dateien zu überschreiben, hat edupsyadmin in früheren Versionen für
+jede Version einen eigenen Unterordner für Konfigurationsdatei und Datenbank
+erstellt. Ab Version 9.0.0 werden diese Daten automatisch in einen stabilen
+Ordner migriert, damit bei zukünftigen Updates keine manuellen Schritte mehr
+nötig sind.
+
+Bei jedem Update, das eine Datenbank-Migration erfordert, erstellt edupsyadmin
+automatisch ein Backup der Datenbank unter ``edupsyadmin.db.bak`` im selben
+Ordner.
+
+.. warning::
+
+    Backups müssen manuell gelöscht werden, sobald das Update erfolgreich
+    abgeschlossen wurde, um den Datenschutz zu gewährleisten. Wenn zum
+    Beispiel ein Klient gelöscht wird, bleibt dessen Datensatz im Backup
+    weiterhin bestehen, bis die Backup-Datei gelöscht wird.
+
+Überprüfe mit folgendem Befehl, wo deine Dateien liegen und ob ein Backup
+existiert:
+
+.. code-block:: console
+
+   $ edupsyadmin info
+
+Update der App
+--------------
+
+Aktualisiere vor dem Update uv und python:
+
+.. tab-set::
+    :sync-group: update-os
+
+    .. tab-item:: Windows
+        :sync: windows-os
+
+        .. code-block:: console
+
+           $ winget upgrade uv
+           $ uv python upgrade
+
+    .. tab-item:: macOS und Linux
+        :sync: macos-linux-os
+
+        .. code-block:: console
+
+           $ uv self update
+           $ uv python upgrade
+
+
+Nun aktualisiere edupsyadmin mit:
+
+.. code-block:: console
+
+   $ uv tool upgrade edupsyadmin --python 3.14
+
+Mit ``edupsyadmin --version`` kannst du überprüfen, welche Version von
+edupsyadmin jetzt installiert ist.
+
+Nach dem Update migriert edupsyadmin deine Daten beim ersten Start automatisch
+an den neuen, stabilen Speicherort. Du musst keine Dateien mehr manuell
+verschieben.