Python Package

Dokumentationsqualitaet

Best Practices fuer Docstrings, README-Dateien und Dokumentations-Qualitaetsgates.

Früher Zugriff: Bis 2026-12-31

Zurück Überblick Voraussetzungen

Gute Dokumentation sorgt bei mgpy dafuer, dass CLI, API und Release-Artefakte dieselbe Geschichte erzaehlen. Fehlende Doku erzeugt Support- und Integrationskosten.

Kernpunkte

CLI: Unter Windows zeigen die Beispiele den empfohlenen Aufruf via py -3.12 -m <modul> ... (z.B. py -3.12 -m manifestguard ...). Auf Linux/macOS entspricht das in der Regel python3.12 -m ....
README, Installationsguide und Docstrings muessen denselben Einstiegspfad beschreiben.
Oeffentliche APIs sollten Rueckgabewerte, Fehlerfaelle und Beispielaufrufe dokumentieren.
Dokumentation gehoert in die Release-Pipeline, nicht erst in Nacharbeiten nach dem Merge.

Empfohlener MG-Python-Workflow

Zuerst die oeffentlichen CLI- und API-Pfade dokumentieren, die externe Nutzer wirklich sehen.
Danach Implementierungsdetails, ADRs und Spezialworkflows ergaenzen.
Vor einem Release pruefen, ob README, INSTALLATION und CI-Beispiele noch dieselben Befehle zeigen.

Schnellstart

py -3.12 -m manifestguard check --extended
py -3.12 -m manifestguard schema --output openapi.json
py -3.12 run_manifestguard.py --report .manifestguard/manifestguard-report.json

Voraussetzungen



Installation interpreter	Python 3.12 + pip	Recommended default path for installation and CLI calls.
Project target versions	Python 3.8 to 3.12	These are the project/runtime targets mgpy can analyze.
mgpy runtime	Validated on Python 3.10 to 3.13	The tool runtime itself is covered for this range.
CLI invocation	Windows: py -3.12 -m manifestguard	Linux/macOS usually maps to python3.12 -m manifestguard.
Runtime packages	tomlkit, click, pydantic, packaging, watchdog, PyNaCl, rfc8785	tomli is only added for Python below 3.11.
Offline / wheel install	Optional via pip --no-index or wheel	Useful for air-gapped or approved bundle distribution paths.