docstring-format-checker 0.5.0__tar.gz → 1.6.3__tar.gz

{docstring_format_checker-0.5.0 → docstring_format_checker-1.6.3}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: docstring-format-checker
-Version: 0.5.0
+Version: 1.6.3
 Summary: A CLI tool to check and validate Python docstring formatting and completeness
 Author: Chris Mahoney
 Author-email: Chris Mahoney <docstring-format-checker@data-science-extensions.com>
 License-Expression: MIT
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Topic :: Software Development :: Quality Assurance
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
@@ -17,17 +17,19 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Intended Audience :: Developers
 Classifier: Environment :: Console
 Requires-Dist: typer>=0.9.0
 Requires-Dist: tomli>=2.0.0 ; python_full_version < '3.11'
 Requires-Dist: rich>=13.0.0
 Requires-Dist: toolbox-python==1.*
+Requires-Dist: pyfiglet==1.*
 Maintainer: Chris Mahoney
 Maintainer-email: Chris Mahoney <docstring-format-checker@data-science-extensions.com>
 Requires-Python: >=3.9
 Project-URL: Changelog, https://github.com/data-science-extensions/docstring-format-checker/releases
-Project-URL: Documentation, https://github.com/data-science-extensions/docstring-format-checker/blob/main/README.md
+Project-URL: Documentation, https://data-science-extensions.com/toolboxes/docstring-format-checker/latest/code/
 Project-URL: Homepage, https://github.com/data-science-extensions/docstring-format-checker
 Project-URL: Issues, https://github.com/data-science-extensions/docstring-format-checker/issues
 Project-URL: Repository, https://github.com/data-science-extensions/docstring-format-checker

{docstring_format_checker-0.5.0 → docstring_format_checker-1.6.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "docstring-format-checker"
-version = "v0.5.0"
+version = "1.6.3"
 description = "A CLI tool to check and validate Python docstring formatting and completeness"
 readme = "README.md"
 license = "MIT"
@@ -11,7 +11,7 @@ maintainers = [
     { name="Chris Mahoney", email="docstring-format-checker@data-science-extensions.com" },
 ]
 classifiers = [
-    "Development Status :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
     "License :: OSI Approved :: MIT License",
     "Topic :: Software Development :: Quality Assurance",
     "Topic :: Software Development :: Libraries :: Python Modules",
@@ -23,6 +23,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Intended Audience :: Developers",
     "Environment :: Console",
 ]
@@ -32,11 +33,12 @@ dependencies = [
     "tomli>=2.0.0;python_version<'3.11'",
     "rich>=13.0.0",
     "toolbox-python==1.*",
+    "pyfiglet==1.*",
 ]
 
 [project.urls]
 Homepage = "https://github.com/data-science-extensions/docstring-format-checker"
-Documentation = "https://github.com/data-science-extensions/docstring-format-checker/blob/main/README.md"
+Documentation = "https://data-science-extensions.com/toolboxes/docstring-format-checker/latest/code/"
 Repository = "https://github.com/data-science-extensions/docstring-format-checker"
 Changelog = "https://github.com/data-science-extensions/docstring-format-checker/releases"
 Issues = "https://github.com/data-science-extensions/docstring-format-checker/issues"
@@ -66,7 +68,7 @@ docs = [
     "mike==2.*",
     "mkdocs==1.*",
     "mkdocs-autorefs==1.*",
-    "mkdocs-coverage==1.*",
+    "mkdocs-coverage==2.*",
     "mkdocs-material==9.*",
     "mkdocstrings==0.*",
     "mkdocstrings-python==1.*",
@@ -77,11 +79,12 @@ test = [
     "parameterized==0.*",
     "pytest==8.*",
     "pytest-clarity==1.*",
-    "pytest-cov==6.*",
+    "pytest-cov==7.*",
     "pytest-icdiff==0.*",
     "pytest-sugar==1.*",
     "pytest-xdist==3.*",
     "requests==2.*",
+    "complexipy==4.*",
 ]
 
 [tool.black]
@@ -146,6 +149,33 @@ lines_after_imports = 2
 [tool.codespell]
 ignore-words-list = "demog"
 
+[tool.pylint.main]
+disable = [
+    "C0103",  # invalid-name
+    "C0301",  # line-too-long
+    "C0302",  # too-many-lines
+    "R0913",  # too-many-arguments
+    "R0914",  # too-many-locals
+    "R0915",  # too-many-statements
+    "R0917",  # too-many-positional-arguments
+    "R1705",  # no-else-return
+    "R1724",  # no-else-continue
+    "W0107",  # unnecessary-pass
+    "W0212",  # protected-access
+    "W0612",  # unused-variable
+    "W0613",  # unused-argument
+    "W0622",  # redefined-builtin
+    "W0718",  # broad-exception-caught
+]
+
+[tool.complexipy]
+paths = "src/docstring_format_checker"
+max-complexity-allowed = 13
+quiet = false
+ignore-complexity = false
+details = "low"
+sort = "asc"
+
 [tool.bump_version.replacements]
 files = [
     { file = "src/docstring_format_checker/__init__.py", pattern = "__version__ = \"{VERSION}\"" },
@@ -154,64 +184,21 @@ files = [
 ]
 
 [tool.dfc]
-# Default configuration for docstring format checker
-
-[[tool.dfc.sections]]
-order = 1
-name = "summary"
-type = "free_text"
-admonition = "note"
-prefix = "!!!"
-required = true
-
-[[tool.dfc.sections]]
-order = 2
-name = "details"
-type = "free_text"
-admonition = "info"
-prefix = "???+"
-required = false
-
-[[tool.dfc.sections]]
-order = 3
-name = "params"
-type = "list_name_and_type"
-required = true
-
-[[tool.dfc.sections]]
-order = 4
-name = "returns"
-type = "list_name_and_type"
-required = false
-
-[[tool.dfc.sections]]
-order = 5
-name = "yields"
-type = "list_type"
-required = false
-
-[[tool.dfc.sections]]
-order = 6
-name = "raises"
-type = "list_type"
-required = false
-
-[[tool.dfc.sections]]
-order = 7
-name = "examples"
-type = "free_text"
-admonition = "example"
-prefix = "???+"
-required = false
-
-[[tool.dfc.sections]]
-order = 8
-name = "notes"
-type = "free_text"
-admonition = "note"
-prefix = "???"
-required = false
+allow_undefined_sections = false
+require_docstrings = true
+check_private = true
+validate_param_types = true
+sections = [
+    { order=1, name="summary",  type="free_text",          required=true,  admonition="note",     prefix="!!!" },
+    { order=2, name="details",  type="free_text",          required=false, admonition="abstract", prefix="???+" },
+    { order=3, name="params",   type="list_name_and_type", required=false, admonition=false },
+    { order=4, name="raises",   type="list_type",          required=false, admonition=false },
+    { order=5, name="returns",  type="list_name_and_type", required=false, admonition=false },
+    { order=6, name="yields",   type="list_type",          required=false, admonition=false },
+    { order=7, name="examples", type="free_text",          required=false, admonition="example",  prefix="???+" },
+    { order=8, name="notes",    type="free_text",          required=false, admonition="note",     prefix="???" },
+]
 
 [build-system]
-requires = ["uv_build>=0.7.19,<0.8.0"]
+requires = ["uv_build>=0.8.17,<0.9.0"]
 build-backend = "uv_build"

{docstring_format_checker-0.5.0 → docstring_format_checker-1.6.3}/src/docstring_format_checker/__init__.py

@@ -4,16 +4,20 @@ Docstring Format Checker.
 A CLI tool to check and validate Python docstring formatting and completeness.
 """
 
-__version__ = "v0.5.0"
-__author__ = "Chris Mahoney"
-__email__ = "docstring-format-checker@data-science-extensions.com"
-
+# ## Python StdLib Imports ----
+from importlib.metadata import metadata
 
 # ## Local First Party Imports ----
 from docstring_format_checker.config import DEFAULT_CONFIG, load_config
 from docstring_format_checker.core import DocstringChecker, SectionConfig
 
 
+_metadata = metadata("docstring-format-checker")
+__name__: str = _metadata["Name"]
+__version__: str = _metadata["Version"]
+__author__: str = _metadata["Author"]
+__email__: str = _metadata.get("Email", "")
+
 __all__: list[str] = [
     "DocstringChecker",
     "SectionConfig",