Python Package

Qualite de la documentation

Bonnes pratiques pour les docstrings, les README et les gates de qualite de documentation.

Accès anticipé: Jusquu2019au 2026-12-31

Retour Aperçu Prérequis

Une bonne documentation garantit que la CLI, l API et les artefacts de release mgpy racontent la meme histoire. Une documentation manquante augmente les couts de support et d integration.

Points cles

CLI: Sous Windows, les exemples utilisent la forme recommandee py -3.12 -m <module> ... (par ex. py -3.12 -m manifestguard ...). Sous Linux/macOS, cela correspond generalement a python3.12 -m ....
README, guide d installation et docstrings doivent decrire le meme chemin d entree.
Les API publiques doivent documenter valeurs de retour, cas d erreur et exemples d appel.
La documentation doit faire partie du pipeline de release, pas d une phase de rattrapage apres merge.

Workflow mgpy recommande

Documenter d abord les chemins CLI et API publics que les utilisateurs voient reellement.
Ajouter ensuite les details d implementation, ADR et workflows speciaux.
Avant une release, verifier que README, INSTALLATION et exemples CI montrent encore les memes commandes.

Demarrage rapide

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

Prérequis



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.