checkup 0.4.0__tar.gz → 0.5.1__tar.gz

{checkup-0.4.0 → checkup-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: checkup
-Version: 0.4.0
+Version: 0.5.1
 Summary: Computational governance framework for measuring data product health
 Author: Jan Vanbuel
 Author-email: Jan Vanbuel <jan.vanbuel@ond.vlaanderen.be>

{checkup-0.4.0 → checkup-0.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "checkup"
-version = "0.4.0"
+version = "0.5.1"
 description = "Computational governance framework for measuring data product health"
 readme = "README.md"
 authors = [{ name = "Jan Vanbuel", email = "jan.vanbuel@ond.vlaanderen.be" }]

checkup-0.5.1/src/checkup/cli/__init__.py

@@ -0,0 +1,39 @@
+"""
+Checkup CLI application.
+"""
+
+from importlib.metadata import version as pkg_version
+from typing import Annotated
+
+import typer
+
+from checkup.cli.commands import config, init, plugins, run, schema
+
+app = typer.Typer(
+    name="checkup",
+    help="CheckUp - Computational governance framework for measuring data product health",
+    no_args_is_help=True,
+)
+
+
+def version_callback(value: bool) -> None:
+    if value:
+        typer.echo(pkg_version("checkup"))
+        raise typer.Exit()
+
+
+@app.callback()
+def main(
+    version: Annotated[
+        bool | None,
+        typer.Option("--version", "-v", callback=version_callback),
+    ] = None,
+) -> None:
+    pass
+
+
+app.command()(run)
+app.command()(init)
+app.command()(config)
+app.command()(schema)
+app.command()(plugins)

{checkup-0.4.0 → checkup-0.5.1}/src/checkup/cli/commands/__init__.py

@@ -4,12 +4,14 @@ CLI commands.
 
 from checkup.cli.commands.config import config
 from checkup.cli.commands.init import init
+from checkup.cli.commands.plugins import plugins
 from checkup.cli.commands.run import run
 from checkup.cli.commands.schema import schema
 
 __all__ = [
     "config",
     "init",
+    "plugins",
     "run",
     "schema",
 ]

checkup-0.5.1/src/checkup/cli/commands/plugins.py

@@ -0,0 +1,49 @@
+"""
+Plugins command. List installed checkup plugins.
+"""
+
+from rich.console import Console
+from rich.table import Table
+
+from checkup.registry import get_registry
+
+console = Console()
+
+
+def plugins() -> None:
+    """
+    List installed checkup plugins.
+    """
+
+    all_plugins = get_registry().list_plugins()
+    all_plugins.pop("checkup", None)
+
+    if not all_plugins:
+        console.print("[yellow]No checkup plugins installed[/yellow]")
+        return
+
+    kinds = [
+        ("Providers", "providers"),
+        ("Metrics", "metrics"),
+        ("Materializers", "materializers"),
+    ]
+    populated_kinds = [  # Hide columns that are empty
+        (header, attr)
+        for header, attr in kinds
+        if any(getattr(p, attr) for p in all_plugins.values())
+    ]
+
+    table = Table(title="Installed checkup plugins")
+    table.add_column("Plugin", style="bold", overflow="fold")
+    table.add_column("Version", overflow="fold")
+    for header, _ in populated_kinds:
+        table.add_column(header, overflow="fold")
+
+    for name, plugin in all_plugins.items():
+        table.add_row(
+            name,
+            plugin.version or "",
+            *("\n".join(getattr(plugin, attr)) for _, attr in populated_kinds),
+        )
+
+    console.print(table)

{checkup-0.4.0 → checkup-0.5.1}/src/checkup/registry/__init__.py

@@ -3,11 +3,13 @@ Plugin registry for discovering providers, metrics, and materializers.
 """
 
 from checkup.registry.discovery import (
+    Plugin,
     PluginRegistry,
     get_registry,
 )
 
 __all__ = [
+    "Plugin",
     "PluginRegistry",
     "get_registry",
 ]

{checkup-0.4.0 → checkup-0.5.1}/src/checkup/registry/discovery.py

@@ -3,6 +3,7 @@ Plugin discovery via Python entry points.
 """
 
 import logging
+from dataclasses import dataclass, field
 from importlib.metadata import entry_points
 from typing import TYPE_CHECKING
 
@@ -13,6 +14,19 @@ if TYPE_CHECKING:
 
 logger = logging.getLogger(__name__)
 
+
+@dataclass
+class Plugin:
+    """
+    A distribution registering one or more checkup entry points.
+    """
+
+    version: str | None
+    providers: list[str] = field(default_factory=list)
+    metrics: list[str] = field(default_factory=list)
+    materializers: list[str] = field(default_factory=list)
+
+
 # Entry point group names
 PROVIDERS_GROUP = "checkup.providers"
 METRICS_GROUP = "checkup.metrics"
@@ -137,6 +151,37 @@ class PluginRegistry:
 
         return self._list_entry_point_names(MATERIALIZERS_GROUP)
 
+    def list_plugins(self) -> dict[str, Plugin]:
+        """
+        List installed plugins grouped by distribution.
+
+        Walks all checkup entry-point groups and groups them by the
+        distribution that registers them. Does not load plugin code.
+        """
+
+        groups = {
+            "providers": PROVIDERS_GROUP,
+            "metrics": METRICS_GROUP,
+            "materializers": MATERIALIZERS_GROUP,
+        }
+
+        plugins: dict[str, Plugin] = {}
+
+        for kind, group in groups.items():
+            for ep in entry_points(group=group):
+                dist = ep.dist
+                dist_name = dist.name if dist else "unknown"
+                dist_version = dist.version if dist else None
+
+                plugin = plugins.setdefault(dist_name, Plugin(version=dist_version))
+                getattr(plugin, kind).append(ep.name)
+
+        for plugin in plugins.values():
+            for kind in groups:
+                getattr(plugin, kind).sort()
+
+        return dict(sorted(plugins.items()))
+
     def list_compatible_metric_names(self, provider_names: list[str]) -> list[str]:
         """
         List metric names compatible with the given providers.

checkup-0.4.0/src/checkup/cli/__init__.py

@@ -1,18 +0,0 @@
-"""
-Checkup CLI application.
-"""
-
-import typer
-
-from checkup.cli.commands import config, init, run, schema
-
-app = typer.Typer(
-    name="checkup",
-    help="CheckUp - Computational governance framework for measuring data product health",
-    no_args_is_help=True,
-)
-
-app.command()(run)
-app.command()(init)
-app.command()(config)
-app.command()(schema)