Paddy
08232bda9b
- install.sh: one-time Linux Mint setup (apt, .venv, requirements, .desktop entry with absolute paths). Re-runnable. - run.sh: launches the app from .venv (called by the menu entry). - icon.png: bundled 256px red-cross launcher/window icon; app prefers it over the runtime-drawn fallback (data/icon.png). - requirements.txt: fully pinned incl. transitive deps, tested on Python 3.12; numpy held at 2.2.6 so it installs on Python 3.10 too. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
35 lines
2.0 KiB
Markdown
35 lines
2.0 KiB
Markdown
# DRK Blutspende – Arbeitsorte: Dokumentation
|
||
|
||
Developer/maintainer documentation for the **Arbeitsorte-Logger**, a small
|
||
desktop app that records blood-drive work assignments (date + city + postal
|
||
code) and plots them on an interactive map.
|
||
|
||
> Context: built as a personal tool for a single user, running locally on a
|
||
> **Linux Mint laptop**. Ease of use for a non-technical user is the primary
|
||
> design constraint. There is no server, no multi-user story, and no network
|
||
> dependency beyond geocoding and the map tiles.
|
||
|
||
## Documents
|
||
|
||
| File | Contents |
|
||
|------|----------|
|
||
| [overview.md](overview.md) | What the app does, feature by feature |
|
||
| [architecture.md](architecture.md) | Code structure, threading model, data flow |
|
||
| [data-model.md](data-model.md) | The `orte.csv` schema and how it is read/written |
|
||
| [setup.md](setup.md) | `git clone` + `./install.sh` on Linux Mint; how updates work |
|
||
| [improvements.md](improvements.md) | Prioritized review findings and suggested changes |
|
||
| [changelog.md](changelog.md) | What has changed, newest first |
|
||
| [dev-notes.md](dev-notes.md) | Assumptions that turned out wrong — read before editing |
|
||
|
||
## At a glance
|
||
|
||
- **Language / stack:** Python 3, Tkinter via [`ttkbootstrap`](https://ttkbootstrap.readthedocs.io/)
|
||
- **Single file:** [`app.py`](../app.py) (~760 lines)
|
||
- **Storage:** one CSV file, `data/orte.csv`
|
||
- **Map:** generated on demand as `data/karte.html` with [Folium](https://python-visualization.github.io/folium/) (Leaflet), opened in the default browser
|
||
- **Geocoding:** OpenStreetMap Nominatim via [`geopy`](https://geopy.readthedocs.io/), rate-limited to 1 request/second on a background thread
|
||
- **UI language:** German; DRK-red header, enlarged font, colour-coded status bar, window position remembered
|
||
- **Persistence:** atomic CSV writes + rotating backups in `data/backups/`; log at `data/app.log`
|
||
- **Tests:** non-GUI smoke checks only (not yet a committed `tests/` suite)
|
||
- **Version control:** git initialized 2026-09-07; in-app self-update (`git` fast-forward + restart) via the Hilfe menu
|