core-dev-tools 2.0.0__tar.gz → 2.1.0__tar.gz

{core_dev_tools-2.0.0 → core_dev_tools-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: core-dev-tools
-Version: 2.0.0
+Version: 2.1.0
 Summary: This library provides common tools used for development...
 Author-email: Alejandro Cora González <alek.cora.glez@gmail.com>
 Maintainer: Alejandro Cora González
@@ -80,6 +80,10 @@ the ecosystem without any per-project duplication.
 
 ===============================================================================
 
+.. image:: https://static.pepy.tech/personalized-badge/core-dev-tools?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads
+    :target: https://pepy.tech/projects/core-dev-tools
+    :alt: PyPI Downloads
+
 .. image:: https://img.shields.io/pypi/pyversions/core-dev-tools.svg
     :target: https://pypi.org/project/core-dev-tools/
     :alt: Python Versions
@@ -131,6 +135,37 @@ on the ``PATH``:
 For detailed documentation, visit: https://core-dev-tools.readthedocs.io/
 
 
+Development
+===============================================================================
+
+**Run the test suite:**
+
+.. code-block:: bash
+
+    python -m unittest discover -v tests/unit
+
+**Run tests with coverage report:**
+
+.. code-block:: bash
+
+    coverage run -m unittest discover tests/unit
+    coverage report -m                                  # Terminal summary
+    coverage html                                       # HTML report in htmlcov/
+
+**Run linters against the package:**
+
+.. code-block:: bash
+
+    python manager.py run-linters core_dev_tools
+    python manager.py run-linters core_dev_tools --tool ruff --tool mypy   # Specific tools only
+
+**Run security scanners against the package:**
+
+.. code-block:: bash
+
+    python manager.py run-security core_dev_tools
+
+
 CI/CD Usage
 ===============================================================================
 

{core_dev_tools-2.0.0 → core_dev_tools-2.1.0}/README.rst

@@ -26,6 +26,10 @@ the ecosystem without any per-project duplication.
 
 ===============================================================================
 
+.. image:: https://static.pepy.tech/personalized-badge/core-dev-tools?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads
+    :target: https://pepy.tech/projects/core-dev-tools
+    :alt: PyPI Downloads
+
 .. image:: https://img.shields.io/pypi/pyversions/core-dev-tools.svg
     :target: https://pypi.org/project/core-dev-tools/
     :alt: Python Versions
@@ -77,6 +81,37 @@ on the ``PATH``:
 For detailed documentation, visit: https://core-dev-tools.readthedocs.io/
 
 
+Development
+===============================================================================
+
+**Run the test suite:**
+
+.. code-block:: bash
+
+    python -m unittest discover -v tests/unit
+
+**Run tests with coverage report:**
+
+.. code-block:: bash
+
+    coverage run -m unittest discover tests/unit
+    coverage report -m                                  # Terminal summary
+    coverage html                                       # HTML report in htmlcov/
+
+**Run linters against the package:**
+
+.. code-block:: bash
+
+    python manager.py run-linters core_dev_tools
+    python manager.py run-linters core_dev_tools --tool ruff --tool mypy   # Specific tools only
+
+**Run security scanners against the package:**
+
+.. code-block:: bash
+
+    python manager.py run-security core_dev_tools
+
+
 CI/CD Usage
 ===============================================================================
 

core_dev_tools-2.1.0/core_dev_tools/__init__.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+
+"""
+Provides common tools used for development.
+"""
+
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version
+
+try:
+    __version__ = version("core-dev-tools")
+
+except PackageNotFoundError:
+    __version__ = "unknown"
+
+
+__all__ = [
+    "__version__",
+]

core_dev_tools-2.1.0/core_dev_tools/cli/runner.py

@@ -0,0 +1,136 @@
+# -*- coding: utf-8 -*-
+
+"""
+This module provides a group of CLI commands that abstract linter, type
+checker, and security tool execution. Consuming projects import ``cli_dev``
+and wire it into their own ``CommandCollection`` to expose ``run-linters`` and
+``run-security`` without duplicating this logic.
+
+**Available Commands:**
+
+  * ``python manager.py run-linters <package>``
+  * ``python manager.py run-linters core_dev_tools --tool ruff``
+  * ``python manager.py run-linters core_dev_tools --tool mypy --tool pyright``
+  * ``python manager.py run-security <package>``
+"""
+
+from __future__ import annotations
+
+import subprocess  # nosec B404
+import sys
+from typing import List, Tuple
+
+from click import argument, echo, option
+from click.decorators import group
+
+LINTERS: List[Tuple[str, List[str]]] = [
+    ("ty", ["ty", "check"]),
+    ("ruff", ["ruff", "check"]),
+    ("mypy", ["mypy", "--explicit-package-bases"]),
+    ("pyright", ["pyright"]),
+    ("pylint", ["pylint"]),
+]
+
+_LINTER_NAMES = [name for name, _ in LINTERS]
+
+# Third element indicates whether the tool accepts a package path argument.
+SECURITY_TOOLS: List[Tuple[str, List[str], bool]] = [
+    ("bandit", ["bandit", "-r"], True),
+    ("pip-audit", ["pip-audit"], False),
+]
+
+
+@group()
+def cli_dev():
+    """
+    Group of commands related to linters and type checkers.
+    """
+
+
+@cli_dev.command("run-linters")
+@argument("package")
+@option(
+    "-t",
+    "--tool",
+    "tools",
+    multiple=True,
+    type=str,
+    help="Run only the specified linter(s). Can be repeated. "
+    f"Available: {', '.join(_LINTER_NAMES)}. Defaults to all.",
+)
+def run_linters(package: str, tools: Tuple[str, ...]) -> None:
+    """
+    Runs linters and type checkers against PACKAGE.
+
+    :param package: Root package directory to check (e.g. ``core_dev_tools``).
+    :param tools: Subset of linters to run. When omitted, all linters run.
+
+    By default, runs all five tools in order:
+      - ty check
+      - ruff check
+      - mypy
+      - pyright
+      - pylint
+
+    All linters always run; a non-zero exit from any tool is collected and
+    reported at the end, then the command exits with code 1.
+    """
+
+    invalid = set(tools) - set(_LINTER_NAMES)
+    if invalid:
+        echo(
+            f"Unknown linter(s): {', '.join(sorted(invalid))}. "
+            f"Available: {', '.join(_LINTER_NAMES)}",
+            err=True,
+        )
+        sys.exit(1)
+
+    selected = [(name, cmd) for name, cmd in LINTERS if not tools or name in tools]
+
+    failed: List[str] = []
+
+    for name, base_cmd in selected:
+        echo(f"\n--- {name} ---")
+        result = subprocess.run(base_cmd + [package], check=False)  # nosec B603
+        if result.returncode != 0:
+            failed.append(name)
+
+    echo("")
+    if failed:
+        echo(f"Linters failed: {', '.join(failed)}", err=True)
+        sys.exit(1)
+
+    echo("All linters passed.")
+
+
+@cli_dev.command("run-security")
+@argument("package")
+def run_security(package: str) -> None:
+    """
+    Runs security scanners against PACKAGE.
+
+    :param package: Root package directory to scan (e.g. ``core_dev_tools``).
+
+    Runs in order:
+      - bandit -r <package>
+      - pip-audit
+
+    All tools always run; a non-zero exit from any tool is collected and
+    reported at the end, then the command exits with code 1.
+    """
+
+    failed: List[str] = []
+
+    for name, base_cmd, takes_path in SECURITY_TOOLS:
+        echo(f"\n--- {name} ---")
+        cmd = base_cmd + ([package] if takes_path else [])
+        result = subprocess.run(cmd, check=False)  # nosec B603
+        if result.returncode != 0:
+            failed.append(name)
+
+    echo("")
+    if failed:
+        echo(f"Security tools failed: {', '.join(failed)}", err=True)
+        sys.exit(1)
+
+    echo("All security checks passed.")

{core_dev_tools-2.0.0 → core_dev_tools-2.1.0}/core_dev_tools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: core-dev-tools
-Version: 2.0.0
+Version: 2.1.0
 Summary: This library provides common tools used for development...
 Author-email: Alejandro Cora González <alek.cora.glez@gmail.com>
 Maintainer: Alejandro Cora González
@@ -80,6 +80,10 @@ the ecosystem without any per-project duplication.
 
 ===============================================================================
 
+.. image:: https://static.pepy.tech/personalized-badge/core-dev-tools?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads
+    :target: https://pepy.tech/projects/core-dev-tools
+    :alt: PyPI Downloads
+
 .. image:: https://img.shields.io/pypi/pyversions/core-dev-tools.svg
     :target: https://pypi.org/project/core-dev-tools/
     :alt: Python Versions
@@ -131,6 +135,37 @@ on the ``PATH``:
 For detailed documentation, visit: https://core-dev-tools.readthedocs.io/
 
 
+Development
+===============================================================================
+
+**Run the test suite:**
+
+.. code-block:: bash
+
+    python -m unittest discover -v tests/unit
+
+**Run tests with coverage report:**
+
+.. code-block:: bash
+
+    coverage run -m unittest discover tests/unit
+    coverage report -m                                  # Terminal summary
+    coverage html                                       # HTML report in htmlcov/
+
+**Run linters against the package:**
+
+.. code-block:: bash
+
+    python manager.py run-linters core_dev_tools
+    python manager.py run-linters core_dev_tools --tool ruff --tool mypy   # Specific tools only
+
+**Run security scanners against the package:**
+
+.. code-block:: bash
+
+    python manager.py run-security core_dev_tools
+
+
 CI/CD Usage
 ===============================================================================
 

{core_dev_tools-2.0.0 → core_dev_tools-2.1.0}/core_dev_tools.egg-info/SOURCES.txt

@@ -2,8 +2,12 @@ LICENSE
 README.rst
 pyproject.toml
 setup.py
+core_dev_tools/__init__.py
+core_dev_tools/py.typed
 core_dev_tools.egg-info/PKG-INFO
 core_dev_tools.egg-info/SOURCES.txt
 core_dev_tools.egg-info/dependency_links.txt
 core_dev_tools.egg-info/requires.txt
-core_dev_tools.egg-info/top_level.txt
+core_dev_tools.egg-info/top_level.txt
+core_dev_tools/cli/__init__.py
+core_dev_tools/cli/runner.py

core_dev_tools-2.1.0/core_dev_tools.egg-info/top_level.txt

@@ -0,0 +1 @@
+core_dev_tools

{core_dev_tools-2.0.0 → core_dev_tools-2.1.0}/pyproject.toml

@@ -9,7 +9,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "core-dev-tools"
 description = "This library provides common tools used for development..."
-version = "2.0.0"
+version = "2.1.0"
 
 authors = [
     {name = "Alejandro Cora González", email = "alek.cora.glez@gmail.com"}

core_dev_tools-2.0.0/core_dev_tools.egg-info/top_level.txt

@@ -1 +0,0 @@
-