Ein Projekt, das andere ausführen können · Übung
Eine Anleitung für einen frisch entpackten Ordner schreiben
Vervollständige README.md für jemanden, der in einem neu angelegten, leeren Ordner mit den entpackten Dateien beginnt. Gib Python 3.10+ an und lass jeden Befehl direkt den Interpreter der Umgebung auswählen. Aktivierung und Shell-Zustand sind unnötig.
Füge unter macOS and Linux genau diese Reihenfolge ein:
python3 -m venv .venv
./.venv/bin/python -m pip install -r requirements-dev.txt
./.venv/bin/python -m pytest -q
./.venv/bin/python api_catalog.py --help
Füge unter PowerShell Folgendes ein:
py -3 -m venv .venv
.\.venv\Scripts\python.exe -m pip install -r requirements-dev.txt
.\.venv\Scripts\python.exe -m pytest -q
.\.venv\Scripts\python.exe .\api_catalog.py --help
Erkläre, dass jemand zur reinen Laufzeitnutzung („runtime-only“) stattdessen requirements.txt installiert, dass pip den konfigurierten Paketindex des Interpreters („configured package index“) verwendet und dass man bei einem Importfehler zum entpackten Projektstamm („extracted project root“) zurückkehrt. Behalte diese englischen Formulierungen in der Projekt-README bei. Empfiehl niemals globales pip, Aktivierung oder Änderungen der Ausführungsrichtlinie.
Das heruntergeladene Projekt lässt sich außerhalb der Website wieder aufbauen, importieren und testen sowie mit seiner Hilfeausgabe starten. Sein fest vorgegebener Hostname practice-api ist intern für Python Land („internal to Python Land“); ein tatsächlicher Abruf ist nach dem Download also nicht zu erwarten. Halte diese Grenze in der Projekt-README ausdrücklich als „After download, fetching is not expected to succeed.“ fest. Ergänze weder einen öffentlichen oder konfigurierbaren Host noch ein Geheimnis oder einen Ausweg über eine Umgebungsvariable.
Warum rufst du ./.venv/bin/python oder .\.venv\Scripts\python.exe direkt auf?
Aufgabe
Vervollständige die README mit Python 3.10+, den genauen geordneten macOS-/Linux- und PowerShell-Befehlen ohne Aktivierung, Anweisungen zur reinen Laufzeitnutzung, der Formulierung zum konfigurierten Paketindex, der Rückkehr zum Projektstamm und der ehrlichen Grenze für ausschließlich interne Abrufe. Behalte die oben angegebenen englischen Formulierungen in dieser Projektdatei bei.