webfarben/pdf_to_ics
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 4 Wiki Activity

Restructure README with OS install and standalone guidance

Browse Source
This commit is contained in:
webfarben
2026-03-02 18:03:21 +01:00
parent 1bb8820cf1
commit 54516a315a
1 changed files with 83 additions and 185 deletions
Download Patch File Download Diff File Expand all files Collapse all files

268
README.md
View File

@@ -1,153 +1,114 @@
# PDF zu ICS Konverter - Dienstplan Importer # PDF zu ICS Konverter - Dienstplan Importer
Dieses Tool extrahiert Kalenderdaten aus Dienstplan-PDFs und konvertiert sie in das iCalendar-Format (ICS), das von den meisten Kalenderanwendungen importiert werden kann. Dieses Tool extrahiert Kalenderdaten aus Dienstplan-PDFs und konvertiert sie in das iCalendar-Format (ICS), das in gängigen Kalender-Apps importiert werden kann.
## 🎯 Zwei Versionen verfügbar ## 🎯 Varianten
### 1. **GUI-Version** (Grafische Oberfläche) - Empfohlen! ### 1) GUI (empfohlen)
Benutzerfreundliche grafische Oberfläche mit Drag & Drop Support. Native Oberfläche mit wxPython:
```bash ```bash
./start_gui.sh ./start_gui.sh
``` ```
**Features:** **Highlights:**
- ✨ Drag & Drop für PDF-Dateien - Drag & Drop für PDFs
- 📋 Mehrere PDFs gleichzeitig verarbeiten - Mehrere PDFs gleichzeitig
- 📁 Ausgabe-Verzeichnis frei wählbar - Frei wählbares Ausgabe-Verzeichnis
- 📊 Live-Log und Fortschrittsanzeige - Live-Log mit Fortschritt
- 💾 Merkt sich letzte Verzeichnisse - Optionale Filter:
- Ruhetage ausschließen
- Urlaub (060/0060) ausschließen
**Voraussetzung:** wxPython muss installiert sein (wird automatisch versucht; siehe [WXPYTHON_README.md](WXPYTHON_README.md)) ### 2) CLI
Interaktives Textmenü:
### 2. **CLI-Version** (Kommandozeile)
Textbasiertes Menü für die Kommandozeile.
```bash ```bash
./start.sh ./start.sh
``` ```
**Features:** ---
- ⚡ Funktioniert überall ohne zusätzliche Abhängigkeiten
- 🔄 Automatische Verarbeitung aller PDFs im Verzeichnis
- 📝 Textbasiertes interaktives Menü
## Features ## ⚡ Schnellstart (60 Sekunden)
✅ Extrahiert Dienstplan-Informationen aus PDFs 1. GUI starten (`./start_gui.sh` oder `start_gui.cmd` unter Windows)
✅ Erkennt Schicht-Zeitangaben (z.B. 04:51-15:46) 2. PDF-Dateien hinzufügen
✅ Handhabt Nachtschichten korrekt (über Mitternacht hinaus) 3. Optional Filter aktivieren
✅ Erstellt Standard-konforme ICS-Dateien 4. Auf **"ICS Datei erstellen"** klicken
✅ Unterstützt mehrere PDFs gleichzeitig
✅ GUI mit Drag & Drop (optional)
✅ CLI-Menü für schnelle Nutzung
## Installation ---
### Windows (Empfohlen)
1. Installieren Sie **Python 3.10+** und aktivieren Sie bei der Installation die Option **"Add Python to PATH"**. ## 🧩 Installation nach Betriebssystem
2. Öffnen Sie den Projektordner.
3. Starten Sie die GUI per Doppelklick auf `start_gui.cmd`.
Beim ersten Start wird automatisch eine virtuelle Umgebung (`.venv`) erstellt und alle benötigten Pakete installiert. ### Linux (Ubuntu/Debian/Mint)
**Alternative (CLI):** Doppelklick auf `start.cmd`.
**Falls Python nicht gefunden wird (CMD im Projektordner):**
```bat
py -3 -m venv .venv --upgrade-deps
.\.venv\Scripts\python.exe gui_wxpython.py
```
### Schnellstart (Empfohlen)
**Für GUI-Version:**
```bash ```bash
./start_gui.sh ./start_gui.sh
``` ```
Siehe [WXPYTHON_README.md](WXPYTHON_README.md) für wxPython-Hinweise.
**Für CLI-Version:** Beim ersten Start wird automatisch `.venv` erstellt und alles installiert.
```bash
./start.sh
```
### GUI-Version (Empfohlen) Wenn `wxPython` nicht installiert werden kann, helfen häufig:
1. Starten Sie die GUI:
```bash
./start_gui.sh
```
2. Fügen Sie PDF-Dateien hinzu (Button oder Drag & Drop).
3. Optional: Aktivieren Sie Filter wie „Ruhetage ausschließen“ und „Urlaub ausschließen (060, 0060)“.
4. Klicken Sie auf „📄 ICS Datei erstellen“.
Die GUI merkt sich Ihre letzten Verzeichnisse und Exportoptionen.
### CLI-Version
Starten Sie das interaktive Menü:
```bash ```bash
./start.sh sudo apt-get update
sudo apt-get install -y build-essential python3-dev libgtk-3-dev libglib2.0-dev libjpeg-dev libtiff-dev libpng-dev
``` ```
Beide Skripte erstellen automatisch eine Python Virtual Environment und installieren alle benötigten Abhängigkeiten. Für systemweite Installation mit Menüeintrag siehe [INSTALL.md](INSTALL.md).
### Manuelle Installation ### macOS
Die erforderlichen Dependencies sind bereits installiert. Falls Sie das Projekt neu einrichten:
```bash ```bash
python3 -m venv .venv ./start_gui.sh
source .venv/bin/activate
pip install pdfplumber icalendar pypdf2 pytz packaging
``` ```
## Verwendung Beim ersten Start wird `.venv` erstellt und die Abhängigkeiten werden installiert.
### Schnellstart (CLI) ### Windows
1. Kopieren Sie Ihre Dienstplan-PDF-Dateien in ein Verzeichnis 1. Python 3.10+ installieren (Option **Add Python to PATH** aktivieren)
2. Führen Sie das Skript aus: 2. `start_gui.cmd` per Doppelklick starten
```bash Beim ersten Start wird `.venv` automatisch eingerichtet.
python3 pdf_to_ics.py
```
Das Tool findet automatisch alle `.pdf` Dateien im aktuellen Verzeichnis und erstellt entsprechende `.ics` Dateien. ---
### Kommandozeilen-Optionen ## 🧱 Standalone-Apps (ohne Python beim Endnutzer)
Für Build/Packaging auf Linux, macOS und Windows:
- [BUILD_STANDALONE.md](BUILD_STANDALONE.md)
Dort enthalten:
- Build-Skripte pro OS
- Packaging-Skripte für Release-Artefakte
- empfohlene Release-Reihenfolge
---
## 🖥️ CLI-Nutzung
### Beispiele
```bash ```bash
# Alle PDFs im aktuellen Verzeichnis konvertieren # Alle PDFs im aktuellen Verzeichnis konvertieren
python3 pdf_to_ics.py python3 pdf_to_ics.py
# PDFs aus einem bestimmten Verzeichnis konvertieren # Input/Output-Verzeichnis setzen
python3 pdf_to_ics.py --input ./pdfs
# PDFs in anderes Verzeichnis speichern
python3 pdf_to_ics.py --input ./pdfs --output ./ics_dateien python3 pdf_to_ics.py --input ./pdfs --output ./ics_dateien
# Ruhetage ausschließen # Ruhetage ausschließen
python3 pdf_to_ics.py --exclude-rest python3 pdf_to_ics.py --exclude-rest
# Urlaub (060) ausschließen # Urlaub (060/0060) ausschließen
python3 pdf_to_ics.py --exclude-vacation python3 pdf_to_ics.py --exclude-vacation
# Einzelne PDF-Datei konvertieren # Einzelne PDF-Datei
python3 pdf_to_ics.py /pfad/zur/datei.pdf python3 pdf_to_ics.py /pfad/zur/datei.pdf
# Mit detaillierter Ausgabe
python3 pdf_to_ics.py --input ./pdfs -v
# Hilfe anzeigen
python3 pdf_to_ics.py --help
``` ```
**Verfügbare Optionen:** ### Optionen
| Option | Kurzform | Beschreibung | | Option | Kurzform | Beschreibung |
|--------|----------|-------------| |--------|----------|-------------|
@@ -155,106 +116,43 @@ python3 pdf_to_ics.py --help
| `--output DIR` | `-o` | Ausgabe-Verzeichnis für ICS-Dateien (Standard: Eingabe-Verzeichnis) | | `--output DIR` | `-o` | Ausgabe-Verzeichnis für ICS-Dateien (Standard: Eingabe-Verzeichnis) |
| `--exclude-rest` | `-e` | Ruhetage ausschließen (Ruhe, R56, R36, vRWF48, RWE, vR48) | | `--exclude-rest` | `-e` | Ruhetage ausschließen (Ruhe, R56, R36, vRWF48, RWE, vR48) |
| `--exclude-vacation` | `-u` | Urlaub ausschließen (060, 0060) | | `--exclude-vacation` | `-u` | Urlaub ausschließen (060, 0060) |
| `--verbose` | `-v` | Detaillierte Ausgabe anzeigen | | `--verbose` | `-v` | Detaillierte Ausgabe |
| `--help` | `-h` | Hilfe anzeigen | | `--help` | `-h` | Hilfe anzeigen |
### Erweiterte Nutzung ---
Sie können auch direkt mit dem Python-Modul arbeiten: ## 📅 ICS-Import
```python Die erzeugten `.ics`-Dateien lassen sich u. a. in folgende Kalender importieren:
from pdf_to_ics import extract_dienstplan_data, create_ics_from_dienstplan - Outlook
- Google Kalender
- Apple Kalender
- Thunderbird
- LibreOffice
- Android-Kalender-Apps
# PDF verarbeiten ---
dienstplan = extract_dienstplan_data('meine_pdf.pdf')
# ICS erstellen ## 🛠️ Fehlerbehebung
create_ics_from_dienstplan(dienstplan, 'mein_kalender.ics')
```
## Dateiformat - **Keine Events gefunden:** PDF-Layout prüfen
- **GUI startet nicht:** `.venv` löschen und neu starten
### ICS-Datei importieren ```bash
rm -rf .venv
Die erstellte `.ics` Datei kann in folgende Kalenderanwendungen importiert werden: ./start_gui.sh
- **Outlook**: Datei → Öffnen und exportieren → Importieren
- **Google Kalender**: Einstellungen → Kalender importieren
- **iCal/macOS**: Doppelklick auf die .ics Datei
- **Thunderbird**: Kalender → Kalender importieren
- **Android**: Mit einer Kalender-App öffnen
- **LibreOffice**: Datei → Öffnen
## Struktur der extrahierten Daten
Das Tool extrahiert folgende Informationen aus der PDF:
- **Name und Personalnummer**: Des Mitarbeiters
- **Betriebshof**: Standort
- **Sollarbeitszeit**: Gewünschte Arbeitszeit pro Monat
- **Events**: Einzelne Schichten mit:
- Datum
- Dienstart (z.B. "36234", "Ruhe", "Dispo")
- Zeitangabe (falls vorhanden)
## Output
Für jede verarbeitete PDF wird eine entsprechende ICS-Datei erstellt:
```
2026-02-23 DB Köhler00100718_März2026.pdf → 2026-02-23 DB Köhler00100718_März2026.ics
```
Die ICS-Datei enthält ein Event für jeden Arbeitstag mit:
- **Titel**: Name - Dienstart
- **Beschreibung**: Dienstart und Betriebshof
- **Zeit**: Mit aktueller Zeitzone (Europe/Berlin)
## Fehlerbehebung
### Keine Events gefunden?
- Stellen Sie sicher, dass die PDF das erwartete Tabellenformat hat
- Überprüfen Sie die Dateiname und die PDF-Struktur
### Zeitzone falsch?
- Die aktuelle Einstellung ist Europe/Berlin
- Zum Ändern: Bearbeiten Sie die Zeile in `pdf_to_ics.py`:
```python
tz = pytz.timezone('Europe/Berlin') # Ändern SIe diesen Wert
``` ```
- **Zeitzone ändern:** in `pdf_to_ics.py` den Wert `Europe/Berlin` anpassen
## Technische Details
### Projektstruktur
```
ICS-Import/
├── pdf_to_ics.py # Core-Konvertierungslogik
├── gui_wxpython.py # GUI-Version (wxPython)
├── menu.py # CLI-Menü
├── start_gui.sh/cmd # GUI-Startskripte
├── start.sh/cmd # CLI-Startskripte
├── README.md # Diese Datei
└── WXPYTHON_README.md # GUI-spezifische Dokumentation
```
### Technische Spezifikationen
- **Abhängigkeiten**: pdfplumber, icalendar, pytz, pypdf2, packaging
- **Optional für GUI**: wxPython (native Oberfläche)
- **Python-Version**: 3.6+
- **Format**: iCalendar 2.0 (RFC 5545)
- **Konfiguration**: `~/.pdf_to_ics_config.json` (GUI-Einstellungen)
## Lizenz
Dieses Tool ist zur privaten Verwendung gedacht.
--- ---
## 📚 Weitere Dokumentation ## 📚 Weitere Dokumentation
- **[WXPYTHON_README.md](WXPYTHON_README.md)** - Ausführliche GUI-Dokumentation und wxPython-Hinweise - [INSTALL.md](INSTALL.md) - Linux-Installation mit Menüeintrag
- **[BUILD_STANDALONE.md](BUILD_STANDALONE.md)** - Standalone-Builds für Linux, macOS und Windows - [WXPYTHON_README.md](WXPYTHON_README.md) - wxPython-spezifische Hinweise
- **[QUICKSTART.md](QUICKSTART.md)** - Schnellanleitung für den Import in verschiedene Kalender - [BUILD_STANDALONE.md](BUILD_STANDALONE.md) - Standalone-Builds/Packaging
- **[ZUSAMMENFASSUNG.md](ZUSAMMENFASSUNG.md)** - Projekt-Übersicht und technische Details - [QUICKSTART.md](QUICKSTART.md) - Kurzanleitung Kalender-Import
- [ZUSAMMENFASSUNG.md](ZUSAMMENFASSUNG.md) - Projekt- und Changelog-Übersicht
## Lizenz
Dieses Tool ist zur privaten Verwendung gedacht.