checkup 0.5.2__tar.gz → 0.6.0__tar.gz

{checkup-0.5.2 → checkup-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: checkup
-Version: 0.5.2
+Version: 0.6.0
 Summary: Computational governance framework for measuring data product health
 Author: Jan Vanbuel
 Author-email: Jan Vanbuel <jan.vanbuel@ond.vlaanderen.be>
@@ -20,12 +20,17 @@ Project-URL: Issues, https://github.com/datamindedbe/checkup/issues
 Project-URL: Source, https://github.com/datamindedbe/checkup
 Description-Content-Type: text/markdown
 
-# CheckUp
+<p align="center">
+  <img src="https://raw.githubusercontent.com/datamindedbe/checkup/main/assets/banner.png" alt="CheckUp" width="100%" />
+</p>
 
-[![PyPI version](https://img.shields.io/pypi/v/checkup)](https://pypi.org/project/checkup/)
-[![Python versions](https://img.shields.io/pypi/pyversions/checkup)](https://pypi.org/project/checkup/)
+<h3 align="center">Computational Governance Framework</h3>
+<p align="center">for measuring <b>data product health</b></p>
 
-Computational governance framework for measuring data product health.
+<p align="center">
+  <a href="https://pypi.org/project/checkup/"><img src="https://img.shields.io/pypi/v/checkup" alt="PyPI version" /></a>
+  <a href="https://pypi.org/project/checkup/"><img src="https://img.shields.io/pypi/pyversions/checkup" alt="Python versions" /></a>
+</p>
 
 ## Plugins
 

{checkup-0.5.2 → checkup-0.6.0}/README.md

@@ -1,9 +1,14 @@
-# CheckUp
+<p align="center">
+  <img src="https://raw.githubusercontent.com/datamindedbe/checkup/main/assets/banner.png" alt="CheckUp" width="100%" />
+</p>
 
-[![PyPI version](https://img.shields.io/pypi/v/checkup)](https://pypi.org/project/checkup/)
-[![Python versions](https://img.shields.io/pypi/pyversions/checkup)](https://pypi.org/project/checkup/)
+<h3 align="center">Computational Governance Framework</h3>
+<p align="center">for measuring <b>data product health</b></p>
 
-Computational governance framework for measuring data product health.
+<p align="center">
+  <a href="https://pypi.org/project/checkup/"><img src="https://img.shields.io/pypi/v/checkup" alt="PyPI version" /></a>
+  <a href="https://pypi.org/project/checkup/"><img src="https://img.shields.io/pypi/pyversions/checkup" alt="Python versions" /></a>
+</p>
 
 ## Plugins
 

{checkup-0.5.2 → checkup-0.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "checkup"
-version = "0.5.2"
+version = "0.6.0"
 description = "Computational governance framework for measuring data product health"
 readme = "README.md"
 authors = [{ name = "Jan Vanbuel", email = "jan.vanbuel@ond.vlaanderen.be" }]
@@ -32,6 +32,7 @@ checkup = "checkup:main"
 console = "checkup.materializers:ConsoleMaterializer"
 csv = "checkup.materializers:CSVMaterializer"
 html = "checkup.materializers:HTMLMaterializer"
+markdown = "checkup.materializers:MarkdownMaterializer"
 sqlalchemy = "checkup.materializers:SQLAlchemyMaterializer"
 
 [build-system]

{checkup-0.5.2 → checkup-0.6.0}/src/checkup/cli/commands/run.py

@@ -43,14 +43,18 @@ def run(
     multiprocessing: Annotated[
         bool,
         typer.Option(
-            "--multiprocessing",
-            help="When disabled, run sequentially without subprocesses",
+            "--multiprocessing/--no-multiprocessing",
+            help="Use multiprocessing. Disable with --no-multiprocessing to run sequentially without subprocesses",
         ),
     ] = True,
     verbose: Annotated[
         bool,
         typer.Option("--verbose", "-v", help="Verbose output"),
     ] = False,
+    quiet: Annotated[
+        bool,
+        typer.Option("--quiet", "-q", help="Only print materializer output to stdout"),
+    ] = False,
 ) -> None:
     """
     Run metrics and materialize results.
@@ -66,4 +70,5 @@ def run(
         cfg,
         materializer="console" if dry_run else materializer,
         multiprocessing=multiprocessing,
+        quiet=quiet,
     )

{checkup-0.5.2 → checkup-0.6.0}/src/checkup/cli/executor.py

@@ -27,6 +27,7 @@ def execute_checkup(
     config: CheckupConfig,
     materializer: str | None = None,
     multiprocessing: bool = True,
+    quiet: bool = False,
 ) -> None:
     """
     Execute checkup with the given configuration.
@@ -35,23 +36,26 @@ def execute_checkup(
         config: Loaded checkup configuration
         materializer: Override materializer type (e.g., "console")
         multiprocessing: If False, run sequentially without subprocesses
+        quiet: If True, send status/errors to stderr so stdout holds only the materializer output.
     """
 
+    out = Console(stderr=True) if quiet else console
+
     registry = get_registry()
 
-    providers = _resolve_providers(config, registry)
+    providers = _resolve_providers(config, registry, out)
     if not providers:
-        console.print("[yellow]No providers configured[/yellow]")
+        out.print("[yellow]No providers configured[/yellow]")
         return
 
-    metrics = _resolve_metrics(config, registry)
+    metrics = _resolve_metrics(config, registry, out)
     if not metrics:
-        console.print("[yellow]No metrics configured[/yellow]")
+        out.print("[yellow]No metrics configured[/yellow]")
         return
 
-    materializer = _resolve_materializer(config, registry, materializer)
+    materializer = _resolve_materializer(config, registry, materializer, out)
 
-    console.print(f"[blue]Running {len(metrics)} metrics...[/blue]")
+    out.print(f"[blue]Running {len(metrics)} metrics...[/blue]")
 
     result = (
         CheckHub()
@@ -62,7 +66,7 @@ def execute_checkup(
 
     if result.errors:
         for _, error in result.errors:
-            console.print(f"[red]Error: {error}[/red]")
+            out.print(f"[red]Error: {error}[/red]")
 
     result.materialize(materializer)
 
@@ -70,6 +74,7 @@ def execute_checkup(
 def _resolve_providers(
     config: CheckupConfig,
     registry: "PluginRegistry",
+    out: Console = console,
 ) -> list["Provider"]:
     """
     Resolve provider configs to provider instances.
@@ -83,14 +88,14 @@ def _resolve_providers(
     for provider_config in config.providers:
         provider_cls = registry.get_provider(provider_config.name)
         if provider_cls is None:
-            console.print(f"[yellow]Unknown provider: {provider_config.name}[/yellow]")
+            out.print(f"[yellow]Unknown provider: {provider_config.name}[/yellow]")
             continue
 
         try:
             provider = provider_cls(**provider_config.config)
             providers.append(provider)
         except Exception as e:
-            console.print(
+            out.print(
                 f"[red]Failed to instantiate provider {provider_config.name}: {e}[/red]"
             )
 
@@ -100,6 +105,7 @@ def _resolve_providers(
 def _resolve_metrics(
     config: CheckupConfig,
     registry: "PluginRegistry",
+    out: Console = console,
 ) -> list["Metric"]:
     """
     Resolve metric configs to metric instances.
@@ -110,7 +116,7 @@ def _resolve_metrics(
     for metric_config in config.metrics:
         metric_cls = registry.get_metric(metric_config.type)
         if metric_cls is None:
-            console.print(f"[yellow]Unknown metric: {metric_config.type}[/yellow]")
+            out.print(f"[yellow]Unknown metric: {metric_config.type}[/yellow]")
             continue
 
         try:
@@ -121,7 +127,7 @@ def _resolve_metrics(
                 )
             )
         except Exception as e:
-            console.print(
+            out.print(
                 f"[red]Failed to instantiate metric {metric_config.type}: {e}[/red]"
             )
 
@@ -132,6 +138,7 @@ def _resolve_materializer(
     config: CheckupConfig,
     registry: "PluginRegistry",
     override: str | None = None,
+    out: Console = console,
 ) -> "Materializer":
     """
     Resolve materializer config to materializer instance.
@@ -150,13 +157,11 @@ def _resolve_materializer(
     materializer_cls = registry.get_materializer(mat_type)
 
     if materializer_cls is None:
-        console.print(
-            f"[yellow]Unknown materializer: {mat_type}, using console[/yellow]"
-        )
+        out.print(f"[yellow]Unknown materializer: {mat_type}, using console[/yellow]")
         return ConsoleMaterializer()
 
     try:
         return materializer_cls(**mat_config)
     except Exception as e:
-        console.print(f"[red]Failed to instantiate materializer {mat_type}: {e}[/red]")
+        out.print(f"[red]Failed to instantiate materializer {mat_type}: {e}[/red]")
         return ConsoleMaterializer()

{checkup-0.5.2 → checkup-0.6.0}/src/checkup/materializers/__init__.py

@@ -9,11 +9,13 @@ from checkup.materializers.console import ConsoleMaterializer
 from checkup.materializers.csv_file import CSVMaterializer
 from checkup.materializers.database import SQLAlchemyMaterializer
 from checkup.materializers.html_report import HTMLMaterializer
+from checkup.materializers.markdown import MarkdownMaterializer
 
 __all__ = [
     "ConsoleMaterializer",
     "CSVMaterializer",
     "HTMLMaterializer",
+    "MarkdownMaterializer",
     "Materializer",
     "SQLAlchemyMaterializer",
     "group_measurements_by_tags",

checkup-0.6.0/src/checkup/materializers/markdown.py

@@ -0,0 +1,52 @@
+"""Markdown materializer for Markdown table output."""
+
+from checkup.materializers.base import Materializer
+from checkup.measurement import Measurement
+
+COLUMNS = ("Name", "Description", "Value", "Unit", "Diagnostics")
+ALIGNMENTS = ("---", "---", "---:", "---", "---")  # Right-align the Value column.
+
+
+class MarkdownMaterializer(Materializer):
+    """
+    Output measurements as a GitHub-flavoured Markdown table.
+    """
+
+    def materialize(
+        self, measurements: list[Measurement], direct_metric_names: set[str]
+    ) -> None:
+        """
+        Print measurements as a Markdown table.
+        """
+
+        filtered = self._filter_measurements(measurements, direct_metric_names)
+
+        rows = [self._row(COLUMNS), self._row(ALIGNMENTS)]
+        for measurement in filtered:
+            rows.append(
+                self._row(
+                    (
+                        measurement.metric.name,
+                        measurement.metric.description,
+                        str(measurement.value) if measurement.value is not None else "",
+                        measurement.metric.unit,
+                        measurement.diagnostic,
+                    )
+                )
+            )
+        print("\n".join(rows))
+
+    @classmethod
+    def _row(cls, cells: tuple[str, ...]) -> str:
+        return "| " + " | ".join(cls._cell(cell) for cell in cells) + " |"
+
+    @staticmethod
+    def _cell(value: str) -> str:
+        """
+        Escape a value for a Markdown table cell.
+
+        Cells cannot contain a raw pipe (column separator) or newline (row separator),
+        so escape pipes and turn newlines into `<br>`.
+        """
+
+        return str(value or "").replace("|", "\\|").replace("\n", "<br>").strip()