constant-docs 0.4.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- constant_docs/__init__.py +18 -0
- constant_docs/__main__.py +15 -0
- constant_docs/api.py +968 -0
- constant_docs/auto.py +239 -0
- constant_docs/checks.py +494 -0
- constant_docs/cli.py +1085 -0
- constant_docs/config.py +1158 -0
- constant_docs/coverage.py +165 -0
- constant_docs/decisions.py +303 -0
- constant_docs/document.py +438 -0
- constant_docs/fingerprint.py +27 -0
- constant_docs/globs.py +154 -0
- constant_docs/guides/quickstart.md +124 -0
- constant_docs/guides/readme.md +198 -0
- constant_docs/house-style.md +70 -0
- constant_docs/index.py +210 -0
- constant_docs/kinds.py +304 -0
- constant_docs/paths.py +246 -0
- constant_docs/prompts/architecture.md +61 -0
- constant_docs/prompts/cli-reference.md +40 -0
- constant_docs/prompts/config-reference.md +38 -0
- constant_docs/prompts/errors.md +50 -0
- constant_docs/prompts/log.md +22 -0
- constant_docs/prompts/module.md +39 -0
- constant_docs/prompts/spec.md +68 -0
- constant_docs/state.py +273 -0
- constant_docs-0.4.0.dist-info/METADATA +380 -0
- constant_docs-0.4.0.dist-info/RECORD +31 -0
- constant_docs-0.4.0.dist-info/WHEEL +4 -0
- constant_docs-0.4.0.dist-info/entry_points.txt +3 -0
- constant_docs-0.4.0.dist-info/licenses/LICENSE +15 -0
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"""constant-docs — per-module documentation that notices when source drifts."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from importlib.metadata import PackageNotFoundError, version
|
|
6
|
+
|
|
7
|
+
from constant_docs.api import append, apply, plan, prune, settle, verify
|
|
8
|
+
|
|
9
|
+
try:
|
|
10
|
+
__version__ = version("constant-docs")
|
|
11
|
+
except PackageNotFoundError:
|
|
12
|
+
# Running from a checkout that was never installed, or installed under a
|
|
13
|
+
# different distribution name. An unresolvable version is not a reason to
|
|
14
|
+
# make the package unimportable — this line runs at import, so raising here
|
|
15
|
+
# takes down the CLI and every consumer with it.
|
|
16
|
+
__version__ = "0.0.0+unknown"
|
|
17
|
+
|
|
18
|
+
__all__ = ["append", "apply", "plan", "prune", "settle", "verify"]
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"""Entry point for ``python -m constant_docs``.
|
|
2
|
+
|
|
3
|
+
The console script is the usual way in. This exists for the case the shipped
|
|
4
|
+
hook wrapper depends on: the package installed into a virtualenv whose ``bin``
|
|
5
|
+
is not on ``PATH``, which is the normal state of affairs inside a project.
|
|
6
|
+
"""
|
|
7
|
+
|
|
8
|
+
from __future__ import annotations
|
|
9
|
+
|
|
10
|
+
import sys
|
|
11
|
+
|
|
12
|
+
from constant_docs.cli import main
|
|
13
|
+
|
|
14
|
+
if __name__ == "__main__":
|
|
15
|
+
sys.exit(main())
|