Python Package

Dokumentatiounsqualitéit

Best Practices fir Docstrings, README-Dateien an Dokumentatiouns-Qualitéitsgates.

Fréien Zougang: Bis 2026-12-31

Zréck Iwwerbléck Viraussetzungen

Gutt Dokumentatioun suergt bei mgpy dofir, datt CLI, API a Release-Artefakter déi selwecht Geschicht erzielen. Feelend Doku kascht Support- an Integratiounsopwand.

Kaerpunkten

CLI: Ënner Windows weisen d'Beispiller de recommandéierte Start iwwer py -3.12 -m <modul> ... (z.B. py -3.12 -m manifestguard ...). Ënner Linux/macOS ass dat normalerweis python3.12 -m ....
README, Installatiounsguide an Docstrings mussen dee selwechten Entréewee beschreiwen.
Ëffentlech APIe sollen Return-Wäerter, Feelerfäll an Beispill-Opriff dokumentéieren.
Dokumentatioun gehéiert an d Release-Pipeline an net an eng spéider Nofleeg no engem Merge.

Recommandeierte mgpy-Workflow

Als éischt déi ëffentlech CLI- an API-Weeër dokumentéieren, déi extern Notzer wierklech gesinn.
Duerno Implementéierungsdetailer, ADRen a Spezial-Workflows ergänzen.
Virun engem Release kontrolléieren, ob README, INSTALLATION an CI-Beispiller nach ëmmer déi selwecht Kommandoe weisen.

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

Viraussetzungen



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.