quickdbd-cli 0.1.13__tar.gz → 0.1.14__tar.gz

{quickdbd_cli-0.1.13 → quickdbd_cli-0.1.14}/NOTICE

@@ -16,7 +16,8 @@ This product bundles third-party components, distributed unmodified:
 
 The demo gallery (gallery/, not part of the Python package) includes schemas derived from:
 
-* Northwind and AdventureWorks (gallery/northwind, gallery/adventureworks), converted from
+* Northwind, pubs, AdventureWorks and AdventureWorks DW (gallery/northwind, gallery/pubs,
+  gallery/adventureworks, gallery/adventureworks-dw), converted from
   microsoft/sql-server-samples. Copyright (c) Microsoft Corporation. MIT License.
 * Sakila (gallery/sakila), converted from sakila-schema.sql. Copyright (c) 2006, 2026, Oracle and/or
   its affiliates. BSD-3-Clause.

{quickdbd_cli-0.1.13 → quickdbd_cli-0.1.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: quickdbd-cli
-Version: 0.1.13
+Version: 0.1.14
 Summary: Compile QuickDBD-syntax schema files into interactive HTML ER diagrams, with no table limit.
 Project-URL: Homepage, https://github.com/MarkPhamm/quickdbd-cli
 Author: Minh (Mark) Pham
@@ -77,7 +77,7 @@ Every demo is a single HTML page written by `qdbd build`, from a QuickDBD schema
 | [![200 tables](https://raw.githubusercontent.com/MarkPhamm/quickdbd-cli/main/docs/assets/img/gallery/synthetic.png)](https://qdbd.dev/demo/synthetic/)<br>**[200 tables](https://qdbd.dev/demo/synthetic/)**<br>Five business domains, 200 tables and every relationship type. Search, filter, click a table to focus it. | [![Schema diff](https://raw.githubusercontent.com/MarkPhamm/quickdbd-cli/main/docs/assets/img/gallery/diff.png)](https://qdbd.dev/demo/diff/)<br>**[Schema diff](https://qdbd.dev/demo/diff/)**<br>What a branch changed, coloured in: new tables in green, changed columns in amber, removals listed. |
 | [![AdventureWorks](https://raw.githubusercontent.com/MarkPhamm/quickdbd-cli/main/docs/assets/img/gallery/adventureworks.png)](https://qdbd.dev/demo/adventureworks/)<br>**[AdventureWorks](https://qdbd.dev/demo/adventureworks/)**<br>Microsoft's bicycle-company OLTP database: 68 tables in five schemas, one region each, with column descriptions. | [![OMOP CDM on Synthea](https://raw.githubusercontent.com/MarkPhamm/quickdbd-cli/main/docs/assets/img/gallery/synthea.png)](https://qdbd.dev/demo/synthea/#t=concept)<br>**[OMOP CDM on Synthea](https://qdbd.dev/demo/synthea/#t=concept)**<br>OHDSI's dbt-synthea: synthetic patient records mapped to the OMOP Common Data Model. 145 tables, 235 relationships from tests. |
 
-[View all 14 demos →](https://qdbd.dev/demo/)
+[View all 18 demos →](https://qdbd.dev/demo/)
 <!-- gallery:end -->
 
 ## Quickstart

{quickdbd_cli-0.1.13 → quickdbd_cli-0.1.14}/README.md

@@ -49,7 +49,7 @@ Every demo is a single HTML page written by `qdbd build`, from a QuickDBD schema
 | [![200 tables](https://raw.githubusercontent.com/MarkPhamm/quickdbd-cli/main/docs/assets/img/gallery/synthetic.png)](https://qdbd.dev/demo/synthetic/)<br>**[200 tables](https://qdbd.dev/demo/synthetic/)**<br>Five business domains, 200 tables and every relationship type. Search, filter, click a table to focus it. | [![Schema diff](https://raw.githubusercontent.com/MarkPhamm/quickdbd-cli/main/docs/assets/img/gallery/diff.png)](https://qdbd.dev/demo/diff/)<br>**[Schema diff](https://qdbd.dev/demo/diff/)**<br>What a branch changed, coloured in: new tables in green, changed columns in amber, removals listed. |
 | [![AdventureWorks](https://raw.githubusercontent.com/MarkPhamm/quickdbd-cli/main/docs/assets/img/gallery/adventureworks.png)](https://qdbd.dev/demo/adventureworks/)<br>**[AdventureWorks](https://qdbd.dev/demo/adventureworks/)**<br>Microsoft's bicycle-company OLTP database: 68 tables in five schemas, one region each, with column descriptions. | [![OMOP CDM on Synthea](https://raw.githubusercontent.com/MarkPhamm/quickdbd-cli/main/docs/assets/img/gallery/synthea.png)](https://qdbd.dev/demo/synthea/#t=concept)<br>**[OMOP CDM on Synthea](https://qdbd.dev/demo/synthea/#t=concept)**<br>OHDSI's dbt-synthea: synthetic patient records mapped to the OMOP Common Data Model. 145 tables, 235 relationships from tests. |
 
-[View all 14 demos →](https://qdbd.dev/demo/)
+[View all 18 demos →](https://qdbd.dev/demo/)
 <!-- gallery:end -->
 
 ## Quickstart

{quickdbd_cli-0.1.13 → quickdbd_cli-0.1.14}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "quickdbd-cli"
-version = "0.1.13"
+version = "0.1.14"
 description = "Compile QuickDBD-syntax schema files into interactive HTML ER diagrams, with no table limit."
 readme = "README.md"
 license = "Apache-2.0"

quickdbd_cli-0.1.14/src/quickdbd_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.14"

{quickdbd_cli-0.1.13 → quickdbd_cli-0.1.14}/src/quickdbd_cli/cli.py

@@ -3,11 +3,13 @@
 from __future__ import annotations
 
 import argparse
+import dataclasses
+import json
 import sys
 from pathlib import Path
 
 from . import __version__
-from .model import Schema
+from .model import Diagnostic, Schema
 from .project import Project, SelectionError, selector_expr
 
 OK = "No errors found. Good job!"
@@ -36,9 +38,31 @@ def _title(project: Project) -> str:
     return "diagram"
 
 
+def _github_annotation(d: Diagnostic, level: str) -> str:
+    """A GitHub Actions workflow command, which shows `d` inline on the PR's changed lines."""
+
+    def esc(s: str) -> str:
+        return s.replace("%", "%25").replace("\r", "%0D").replace("\n", "%0A")
+
+    def esc_prop(s: str) -> str:
+        return esc(s).replace(":", "%3A").replace(",", "%2C")
+
+    return f"::{level} file={esc_prop(d.path)},line={d.line},title=qdbd::{esc(d.message)}"
+
+
 def cmd_check(args) -> int:
     project = _open(args)
     schema = project.compile()
+    if args.format == "json":
+        ok = not schema.errors and not (args.strict and schema.warnings)
+        diags = [dataclasses.asdict(d) for d in schema.diagnostics]
+        report = {"ok": ok, "errors": len(schema.errors), "warnings": len(schema.warnings), "diagnostics": diags}
+        print(json.dumps(report, indent=2))
+        return 0 if ok else 1
+    if args.format == "github":
+        # Under --strict a warning fails the job, so it's annotated as an error.
+        for d in schema.diagnostics:
+            print(_github_annotation(d, "error" if args.strict else d.severity))
     ok = _print_diagnostics(schema, args.strict)
     if ok and not schema.diagnostics:
         print(OK)
@@ -345,6 +369,12 @@ def build_parser() -> argparse.ArgumentParser:
     sp = sub.add_parser("check", help="validate schema files")
     paths(sp)
     sp.add_argument("--strict", action="store_true", help="treat warnings (QuickDBD incompatibilities) as errors")
+    sp.add_argument(
+        "--format",
+        choices=["text", "github", "json"],
+        default="text",
+        help="github: also emit GitHub Actions annotations (inline on PR lines); json: a machine-readable report",
+    )
     sp.set_defaults(func=cmd_check)
 
     sp = sub.add_parser("build", help="write an interactive HTML diagram")

{quickdbd_cli-0.1.13 → quickdbd_cli-0.1.14}/tests/test_gallery.py

@@ -91,6 +91,11 @@ def test_sample_databases_and_dbt_projects(built):
     assert sizes["adventureworks"][0] == 68 and sizes["adventureworks"][1] >= 90
     assert sizes["synthea"] == (145, 235)
     assert sizes["shopify"][0] == 155 and sizes["shopify"][1] > 150  # every link inferred
+    for d, n in (("pubs", 11), ("adventureworks-dw", 28), ("saas-billing", 13), ("courses", 14)):
+        m = _model(built / d / "index.html")
+        assert len(m["tables"]) == n and m["rels"], d
+    dw = _model(built / "adventureworks-dw" / "index.html")
+    assert {"dim", "fact"} <= {t["name"] for t in dw["tags"]}  # coloured by the Dim/Fact name prefixes
     aw = _model(built / "adventureworks" / "index.html")
     assert aw["regions"] and any(t.get("doc") for t in aw["tables"])  # MS_Description -> tooltips
 

{quickdbd_cli-0.1.13 → quickdbd_cli-0.1.14}/tests/test_pipeline.py

@@ -136,6 +136,47 @@ def test_check_strict_warnings(tmp_path):
     assert main(["check", "--strict", str(f)]) == 1
 
 
+def test_check_format_github(tmp_path, capsys):
+    bad = tmp_path / "bad.txt"
+    bad.write_text("T\n-\nA int foo\nB decimal(10, 2)\n")
+    assert main(["check", "--format", "github", str(bad)]) == 1
+    out = capsys.readouterr().out.splitlines()
+    assert f"::error file={bad},line=3,title=qdbd::Unrecognized keyword 'foo'" in out
+    assert any(line.startswith(f"::warning file={bad},line=4,title=qdbd::QuickDBD would reject this") for line in out)
+
+
+def test_check_format_github_strict_promotes_warnings(tmp_path, capsys):
+    f = tmp_path / "w.txt"
+    f.write_text("T\n-\nA decimal(10, 2)\n")
+    assert main(["check", "--format", "github", "--strict", str(f)]) == 1
+    assert capsys.readouterr().out.startswith(f"::error file={f},line=3,")
+
+
+def test_github_annotation_escaping():
+    from quickdbd_cli.cli import _github_annotation
+    from quickdbd_cli.model import Diagnostic
+
+    d = Diagnostic("a,b:c.txt", 2, "50% bad\nnext", "warning")
+    assert _github_annotation(d, "warning") == "::warning file=a%2Cb%3Ac.txt,line=2,title=qdbd::50%25 bad%0Anext"
+
+
+def test_check_format_json(tmp_path, capsys):
+    bad = tmp_path / "bad.txt"
+    bad.write_text("T\n-\nA int foo\n")
+    assert main(["check", "--format", "json", str(bad)]) == 1
+    data = json.loads(capsys.readouterr().out)
+    assert data["ok"] is False and data["errors"] == 1 and data["warnings"] == 0
+    assert data["diagnostics"] == [
+        {"path": str(bad), "line": 3, "severity": "error", "message": "Unrecognized keyword 'foo'"}
+    ]
+
+
+def test_check_format_json_ok(capsys):
+    assert main(["check", "--format", "json", str(SAMPLE)]) == 0
+    data = json.loads(capsys.readouterr().out)
+    assert data == {"ok": True, "errors": 0, "warnings": 0, "diagnostics": []}
+
+
 def test_build_is_deterministic_and_does_not_write_sidecar(tmp_path):
     work = tmp_path / "s"
     shutil.copytree(SYNTH, work)

quickdbd_cli-0.1.13/src/quickdbd_cli/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.1.13"