Zum Inhalt

Installation

Voraussetzungen

  • Python >= 3.8
  • Git-Zugriff auf das Repository
  • Internetverbindung für das Herunterladen von Formularen
  • uv (empfohlen) oder pip

Installation mit uv (empfohlen)

uv ist ein schneller Python Package Manager. Installation:

# uv installieren (falls noch nicht vorhanden)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Projekt aus Git Repository installieren
uv add git+https://git.bg-kooperation.de/novareto/form_download_helper.git

Installation mit pip

pip install git+https://git.bg-kooperation.de/novareto/form_download_helper.git

Entwicklungsinstallation

Mit uv (empfohlen)

# Repository klonen
git clone https://git.bg-kooperation.de/novareto/form_download_helper.git
cd form_download_helper

# Projekt und alle Abhängigkeiten (inkl. dev) installieren
uv sync --all-extras

# Alternativ: nur bestimmte Gruppen installieren
uv sync --extra dev
uv sync --extra test
uv sync --extra docs

Mit pip

# Repository klonen
git clone https://git.bg-kooperation.de/novareto/form_download_helper.git
cd form_download_helper

# Development-Modus mit dev-Abhängigkeiten
pip install -e ".[dev,test,docs]"

Abhängigkeiten

Das Tool benötigt folgende Python-Pakete:

  • typer>=0.12.3 - CLI Framework
  • requests>=2.31.0 - HTTP Client
  • rich - Terminal-Formatierung (wird automatisch installiert)

Überprüfung der Installation

Nach der Installation können Sie überprüfen, ob alles korrekt funktioniert:

# Mit uv
uv run form-download-helper --help

# Oder falls global installiert
form-download-helper --help

Dies sollte die Hilfe-Ausgabe des Tools anzeigen.

uv Befehle für die Entwicklung

# Abhängigkeiten synchronisieren
uv sync

# Script ausführen
uv run form-download-helper --help

# Tests ausführen
uv run pytest

# Code formatieren
uv run black .
uv run ruff check --fix .

# Typ-Checking
uv run mypy src/

# Dokumentation erstellen
uv run mkdocs serve

Fehlerbehebung

Permission Denied Fehler

Falls Sie Berechtigungsfehler erhalten:

# Installation mit --user Flag
pip install --user git+https://git.bg-kooperation.de/novareto/form_download_helper.git

Python Version Konflikte

Stellen Sie sicher, dass Sie Python 3.8 oder höher verwenden:

python --version

Netzwerk-Probleme

Bei Problemen mit dem Git-Repository:

# SSH statt HTTPS verwenden
pip install git+ssh://git@git.bg-kooperation.de/novareto/form_download_helper.git