docstring-format-checker 1.11.4__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.
- docstring_format_checker/__init__.py +27 -0
- docstring_format_checker/cli.py +917 -0
- docstring_format_checker/config.py +622 -0
- docstring_format_checker/core.py +2289 -0
- docstring_format_checker/utils/__init__.py +0 -0
- docstring_format_checker/utils/exceptions.py +103 -0
- docstring_format_checker-1.11.4.dist-info/METADATA +546 -0
- docstring_format_checker-1.11.4.dist-info/RECORD +10 -0
- docstring_format_checker-1.11.4.dist-info/WHEEL +4 -0
- docstring_format_checker-1.11.4.dist-info/entry_points.txt +4 -0
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Docstring Format Checker.
|
|
3
|
+
|
|
4
|
+
A CLI tool to check and validate Python docstring formatting and completeness.
|
|
5
|
+
"""
|
|
6
|
+
|
|
7
|
+
# ## Python StdLib Imports ----
|
|
8
|
+
from importlib.metadata import metadata
|
|
9
|
+
|
|
10
|
+
# ## Local First Party Imports ----
|
|
11
|
+
from docstring_format_checker.config import DEFAULT_CONFIG, load_config
|
|
12
|
+
from docstring_format_checker.core import DocstringChecker, SectionConfig
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
### Define package metadata ----
|
|
16
|
+
_metadata = metadata("docstring-format-checker")
|
|
17
|
+
__name__: str = _metadata["Name"]
|
|
18
|
+
__version__: str = _metadata["Version"]
|
|
19
|
+
__author__: str = _metadata["Author"]
|
|
20
|
+
__author_email__: str = _metadata["Author-email"]
|
|
21
|
+
|
|
22
|
+
__all__: list[str] = [
|
|
23
|
+
"DocstringChecker",
|
|
24
|
+
"SectionConfig",
|
|
25
|
+
"load_config",
|
|
26
|
+
"DEFAULT_CONFIG",
|
|
27
|
+
]
|