CLASPLint 0.2.0__tar.gz → 0.4.0__tar.gz

CLASPLint-0.4.0/CLASPLint/__init__.py

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+"""
+THIS FILE IS CORE PART OF CLASPLINT BY MATT BELFAST BROWN.
+
+===============================================================================
+
+MODULE               : CLASPLint.__init__
+
+TYPE                 : Python Script
+
+DESCRIPTION          :
+    Package entry point and public API surface. Exposes the runner and reporter
+    modules as the primary public interface for programmatic use of the CLASP
+    3.2 / PEP 2606 static analysis engine.
+
+AUTHOR               : Matt Belfast Brown
+
+CONTACT              : thedayofthedo@gmail.com
+
+MAINTAINER           :
+    Matt Belfast Brown (thedayofthedo@gmail.com)
+
+
+PROJECT CREATE DATE  : 2026-06-17
+
+PROJECT VERSION DATE : 2026-07-05
+
+PROJECT VERSION      : 0.4.0
+
+
+FILE CREATE DATE     : 2026-06-17
+
+FILE VERSION DATE    : 2026-07-05
+
+FILE VERSION         : 0.4.0
+
+
+STATUS               : Stable
+
+PYTHON               : >=3.8
+
+LICENSE              : GPL-3.0-only
+
+SPDX ID              : GPL-3.0-only
+
+
+USAGE                :
+    import CLASPLint
+
+    report = CLASPLint.runner.run(["path/to/code/"])
+    print(report.summary())
+
+===============================================================================
+
+THIS PROGRAM IS LICENSED UNDER GPL-3.0-only LICENSE.
+YOU SHOULD HAVE RECEIVED A COPY OF GPL-3.0-only LICENSE.
+
+Copyright (C) 2026 Matt Belfast Brown.
+
+Sort License:
+
+    CLASPLint is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, version 3 of the License.
+
+    CLASPLint is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty
+    of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with CLASPLint.  If not, see <https://www.gnu.org/licenses/>.
+"""
+
+# Define the package version string.
+__version__ = "0.4.0"
+# Expose the runner and reporter modules as the public API.
+__all__ = ["runner", "reporter"]

{CLASPLint-0.2.0 → CLASPLint-0.4.0}/CLASPLint/__main__.py

@@ -1,33 +1,80 @@
+# -*- coding: utf-8 -*-
 """
-THIS FILE IS PART OF CLASPLINT BY MATT BELFAST BROWN
-CLASPLint.__main__ — command-line entry point for the CLASP 3.0 static analysis tool.
+THIS FILE IS CORE PART OF CLASPLINT BY MATT BELFAST BROWN.
 
-Author: Matt Belfast Brown
-Create Date: 2026-06-17
-Version Date: 2026-06-21
-Version: 0.2.0
+===============================================================================
 
-THIS PROGRAM IS LICENSED UNDER GPL-3.0
-YOU SHOULD HAVE RECEIVED A COPY OF GPL-3.0 LICENSE.
+MODULE               : CLASPLint.__main__
 
-Copyright (C) 2026 Matt Belfast Brown
+TYPE                 : Python Script
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, version 3 of the License.
+DESCRIPTION          :
+    Command-line entry point for the CLASP 3.2 / PEP 2606 static analysis tool.
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty
-of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+AUTHOR               : Matt Belfast Brown
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+CONTACT              : thedayofthedo@gmail.com
+
+MAINTAINER           :
+    Matt Belfast Brown (thedayofthedo@gmail.com)
+
+
+PROJECT CREATE DATE  : 2026-06-17
+
+PROJECT VERSION DATE : 2026-07-05
+
+PROJECT VERSION      : 0.4.0
+
+
+FILE CREATE DATE     : 2026-06-17
+
+FILE VERSION DATE    : 2026-07-05
+
+FILE VERSION         : 0.4.0
+
+
+STATUS               : Stable
+
+PYTHON               : >=3.8
+
+LICENSE              : GPL-3.0-only
+
+SPDX ID              : GPL-3.0-only
+
+
+USAGE                :
+    CLASPLint path/to/file.py
+
+    CLASPLint --quiet src/
+
+    CLASPLint --category variable src/
+
+===============================================================================
+
+THIS PROGRAM IS LICENSED UNDER GPL-3.0-only LICENSE.
+YOU SHOULD HAVE RECEIVED A COPY OF GPL-3.0-only LICENSE.
+
+Copyright (C) 2026 Matt Belfast Brown.
+
+Sort License:
+
+    CLASPLint is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, version 3 of the License.
+
+    CLASPLint is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty
+    of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with CLASPLint.  If not, see <https://www.gnu.org/licenses/>.
 """
 
 import argparse
 import sys
 import os
+from typing import Optional, Sequence
 
 from .runner import run
 from . import __version__
@@ -40,7 +87,7 @@ def _init_build_parser_function_() -> argparse.ArgumentParser:
         # Set the program name displayed in help text.
         prog="CLASPLint",
         # Provide a description of what the tool does.
-        description="CLASP 3.0 / PEP 2606 static analysis tool. "
+        description="CLASP 3.2 / PEP 2606 static analysis tool. "
                     # Continue the description across multiple lines for readability.
                     "Checks variable, dict key, function, class naming "
                     # Complete the tool description with comment and log conventions.
@@ -51,7 +98,7 @@ def _init_build_parser_function_() -> argparse.ArgumentParser:
     parser_result.add_argument(
         # Accept zero or more path strings as positional arguments.
         "paths", nargs="*", default=["."],
-        # Provide the help text for the paths argument.
+        # Provide the help text for the paths' argument.
         help="Python files or directories to check (default: current directory).",
     # Close the first add_argument call.
     )
@@ -93,7 +140,7 @@ def _init_build_parser_function_() -> argparse.ArgumentParser:
     return parser_result
 
 
-def main(argv: list = None) -> int:
+def main(argv: Optional[Sequence[str]] = None) -> int:
     """Execute the CLASPLint analysis and return an exit code (0 = clean, 1 = violations)."""
     # Build and parse command-line arguments.
     parser = _init_build_parser_function_()