Add dependencies and runtime setup documentation

This commit is contained in:
Rob committed 2026-04-21 15:25:40 +02:00
1 parent e34c491719
commit b68de79cfa
4 files changed
+60 -5

No files matched your search

+5 -5
View File
@@ -24,10 +24,10 @@ Projekt vollstaendig umsetzen: aus PS_PW.xlsx und Stellenbeschreibungen.xlsx mon
- [x] Modulaufteilung (cli, parser, matcher, validator, writer, model, util) - [x] Modulaufteilung (cli, parser, matcher, validator, writer, model, util)
- [x] Gemeinsame Datenmodelle (z. B. dataclasses) definieren - [x] Gemeinsame Datenmodelle (z. B. dataclasses) definieren
- [x] Zentrales Logging/Fehlermodell vorbereiten - [x] Zentrales Logging/Fehlermodell vorbereiten
- [ ] T4: Abhaengigkeiten und Laufzeit vorbereiten - [x] T4: Abhaengigkeiten und Laufzeit vorbereiten
- [ ] benoetigte Pakete festlegen (z. B. openpyxl, click) - [x] benoetigte Pakete festlegen (z. B. openpyxl, click)
- [ ] requirements-Datei pflegen - [x] requirements-Datei pflegen
- [ ] Startkommando fuer lokale Ausfuehrung dokumentieren - [x] Startkommando fuer lokale Ausfuehrung dokumentieren
## Phase 3 - Einlesen der Quelldaten ## Phase 3 - Einlesen der Quelldaten
- [ ] T5: Parser fuer PS_PW.xlsx implementieren - [ ] T5: Parser fuer PS_PW.xlsx implementieren
@@ -111,4 +111,4 @@ Projekt vollstaendig umsetzen: aus PS_PW.xlsx und Stellenbeschreibungen.xlsx mon
8. T15 -> T16 -> T17 8. T15 -> T16 -> T17
## Aktueller Startpunkt ## Aktueller Startpunkt
- [ ] Naechste aktive Aufgabe: T4 (Abhaengigkeiten und Laufzeit vorbereiten) - [ ] Naechste aktive Aufgabe: T5 (Parser fuer PS_PW.xlsx implementieren)
+20
View File
@@ -0,0 +1,20 @@
# SAB Taetigkeitsnachweise Tool
## Setup
1. Create and activate a virtual environment.
2. Install dependencies:
```bash
pip install -r requirements.txt
```
## Local run command
Use module execution from the project root:
```bash
python -m src.taetigkeitsnachweis.cli --version
```
Current CLI is a scaffold. Full generation pipeline is implemented in later tasks.
+2
View File
@@ -0,0 +1,2 @@
click>=8.1,<9.0
openpyxl>=3.1,<4.0
+33
View File
@@ -1 +1,34 @@
"""CLI entrypoint and orchestration layer.""" """CLI entrypoint and orchestration layer."""
from __future__ import annotations
import argparse
def build_parser() -> argparse.ArgumentParser:
parser = argparse.ArgumentParser(
prog="taetigkeitsnachweis",
description="SAB Taetigkeitsnachweise generator",
)
parser.add_argument(
"--version",
action="store_true",
help="Show tool version and exit.",
)
return parser
def main() -> int:
parser = build_parser()
args = parser.parse_args()
if args.version:
print("taetigkeitsnachweis 0.1.0")
return 0
print("CLI scaffold ready. Full pipeline will be added in Task T13.")
return 0
if __name__ == "__main__":
raise SystemExit(main())