quickdbd-cli 0.4.2__py3-none-any.whl → 0.5.0__py3-none-any.whl

quickdbd_cli/__init__.py

@@ -1 +1 @@
-__version__ = "0.4.2"
+__version__ = "0.5.0"

quickdbd_cli/assets/icon.svg

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><rect width="128" height="128" rx="28" fill="#2563eb"/><rect x="22" y="22" width="42" height="36" rx="9" fill="#fff"/><path d="M44 58v19a10 10 0 0 0 10 10h12" fill="none" stroke="#fff" stroke-width="8"/><rect x="64" y="70" width="42" height="33" rx="8" fill="#a8c1f7"/></svg>
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><rect width="128" height="128" rx="28" fill="#2b5797"/><rect x="22" y="22" width="42" height="36" rx="9" fill="#fff"/><path d="M44 58v19a10 10 0 0 0 10 10h12" fill="none" stroke="#fff" stroke-width="8"/><rect x="64" y="70" width="42" height="33" rx="8" fill="#a9bfdd"/></svg>

quickdbd_cli/assets/style.css

@@ -34,8 +34,8 @@
   --t-edge: #b8bcc2;
   --row-hl: #dbe6f6;
   --row-hover: #eef3fa;
-  --lit: #4361ee;
-  --lit-deep: #2a3fb8;
+  --lit: #2b5797;
+  --lit-deep: #1c3a66;
 }
 /* Dark theme. viewer.js sets data-theme from the toggle, or from prefers-color-scheme when it's on auto. */
 :root[data-theme="dark"] {

quickdbd_cli/cli.py

@@ -32,11 +32,12 @@ def _open(args) -> Project:
     return Project.open([Path(p) for p in args.paths], Path(args.layout) if getattr(args, "layout", None) else None)
 
 
+def _name(p: Path) -> str:
+    return p.stem if p.is_file() else (p.resolve().name or "diagram")
+
+
 def _title(project: Project) -> str:
-    if len(project.inputs) == 1:
-        p = project.inputs[0]
-        return p.stem if p.is_file() else (p.resolve().name or "diagram")
-    return "diagram"
+    return _name(project.inputs[0]) if len(project.inputs) == 1 else "diagram"
 
 
 def _github_annotation(d: Diagnostic, level: str) -> str:
@@ -76,7 +77,30 @@ def _symbols(schema: Schema) -> dict:
     return {"tables": tables, "rels": rels}
 
 
+def _check_each(args) -> int:
+    """Check each PATH on its own, as ``build --site`` builds them; folders with no schema files are skipped."""
+    from .project import discover
+
+    if args.format == "json" or args.stdin_file:
+        print("error: --each can't be used with --format json or --stdin-file", file=sys.stderr)
+        return 2
+    code, checked = 0, 0
+    for p in args.paths:
+        if Path(p).is_dir() and not discover([Path(p)]):
+            print(f"Skipped {p}: no .txt or .dbml schema files", file=sys.stderr)
+            continue
+        print(f"{p}:")
+        code = max(code, cmd_check(argparse.Namespace(**{**vars(args), "paths": [p], "each": False})))
+        checked += 1
+    if not checked:
+        print("error: no schema files found in: " + ", ".join(args.paths), file=sys.stderr)
+        return 2
+    return code
+
+
 def cmd_check(args) -> int:
+    if args.each:
+        return _check_each(args)
     project = _open(args)
     overrides = None
     if args.stdin_file:
@@ -143,7 +167,52 @@ def _built_page(args) -> tuple[str, dict] | int:
     return render_page(model, pos, _title(project)), model
 
 
+def _build_site(args) -> int:
+    """One page per PATH plus an index linking them, in the folder ``args.site``."""
+    from urllib.parse import quote
+
+    from .html import render_index
+    from .project import discover
+
+    if args.layout:
+        print("error: --layout can't be used with --site: each PATH uses its own layout file", file=sys.stderr)
+        return 2
+    pages, seen, failed = [], {}, 0
+    for p in map(Path, args.paths):
+        if p.is_dir() and not discover([p]):
+            print(f"Skipped {p}: no .txt or .dbml schema files", file=sys.stderr)
+            continue
+        name = _name(p)
+        if name.lower() in seen or name.lower() == "index":
+            other = seen.get(name.lower(), "the index page")
+            print(f"error: {p} and {other} would both be written to {name}.html", file=sys.stderr)
+            return 2
+        seen[name.lower()] = p
+        res = _built_page(argparse.Namespace(**{**vars(args), "paths": [str(p)]}))
+        if isinstance(res, int):
+            failed = max(failed, res)
+            continue
+        pages.append((name, *res))
+    if failed:  # nothing is written, so a failed build never leaves a half-updated site
+        return failed
+    if not pages:
+        print("error: no schema files found in: " + ", ".join(args.paths), file=sys.stderr)
+        return 2
+    out = Path(args.site)
+    out.mkdir(parents=True, exist_ok=True)
+    index = []
+    for name, page, model in pages:
+        (out / f"{name}.html").write_text(page, encoding="utf-8")
+        index.append((name, quote(f"{name}.html"), len(model["tables"]), len(model["rels"])))
+        print(f"Wrote {out / f'{name}.html'} ({len(model['tables'])} tables, {len(model['rels'])} relationships)")
+    (out / "index.html").write_text(render_index(index), encoding="utf-8")
+    print(f"Wrote {out / 'index.html'} ({len(pages)} diagrams)")
+    return 0
+
+
 def cmd_build(args) -> int:
+    if args.site:
+        return _build_site(args)
     res = _built_page(args)
     if isinstance(res, int):
         return res
@@ -575,11 +644,20 @@ def build_parser() -> argparse.ArgumentParser:
         metavar="PATH",
         help="read this schema file's text from stdin instead of disk (an editor's unsaved buffer)",
     )
+    sp.add_argument(
+        "--each",
+        action="store_true",
+        help="check each PATH as its own schema, as build --site does (folders with no schema files are skipped)",
+    )
     sp.set_defaults(func=cmd_check)
 
     sp = sub.add_parser("build", help="write an interactive HTML diagram")
     paths(sp)
-    sp.add_argument("-o", "--output", default="diagram.html")
+    out = sp.add_mutually_exclusive_group()
+    out.add_argument("-o", "--output", default="diagram.html")
+    out.add_argument(
+        "--site", metavar="DIR", help="one page per PATH (named after it) plus an index.html linking them, in DIR"
+    )
     selectors(sp)
     sp.add_argument(
         "--diff-base", metavar="GIT_REF", help="colour tables/columns changed since this git ref (e.g. origin/main)"

quickdbd_cli/html.py

@@ -190,3 +190,28 @@ def render_page(
         f"<script>{_asset('viewer.js')}</script>"
         f"{scripts}</body></html>\n"
     )
+
+
+INDEX_CSS = (
+    ":root{color-scheme:light dark;--fg:#1f2328;--muted:#656d76;--bg:#fff;--line:#d0d7de}"
+    "@media (prefers-color-scheme:dark){:root{--fg:#e6edf3;--muted:#8d96a0;--bg:#0d1117;--line:#30363d}}"
+    "body{margin:0;background:var(--bg);color:var(--fg);font:15px/1.5 system-ui,sans-serif}"
+    "main{max-width:640px;margin:0 auto;padding:32px 16px}h1{font-size:20px;margin:0 0 16px}"
+    "ul{list-style:none;margin:0;padding:0}li{border-top:1px solid var(--line);padding:10px 0}"
+    "a{color:inherit;font-weight:600}span{color:var(--muted);margin-left:8px}"
+)
+
+
+def render_index(pages: list[tuple[str, str, int, int]], title: str = "Diagrams") -> str:
+    """``qdbd build --site``'s index: a link per (name, href, tables, relationships)."""
+    items = "".join(
+        f'<li><a href="{_escape(href)}">{_escape(name)}</a><span>{t} tables, {r} relationships</span></li>'
+        for name, href, t, r in pages
+    )
+    return (
+        '<!doctype html>\n<html lang="en"><head><meta charset="utf-8">'
+        '<meta name="viewport" content="width=device-width, initial-scale=1">'
+        '<meta name="generator" content="qdbd">'
+        f"{favicon()}<title>{_escape(title)}</title><style>{INDEX_CSS}</style></head>"
+        f"<body><main><h1>{_escape(title)}</h1><ul>{items}</ul></main></body></html>\n"
+    )

{quickdbd_cli-0.4.2.dist-info → quickdbd_cli-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: quickdbd-cli
-Version: 0.4.2
+Version: 0.5.0
 Summary: Compile QuickDBD-syntax schema files into interactive HTML ER diagrams, with no table limit.
 Project-URL: Homepage, https://qdbd.dev/
 Project-URL: Documentation, https://qdbd.dev/guide/
@@ -193,7 +193,7 @@ jobs:
     permissions: { contents: read, pull-requests: write }
     steps:
       - uses: actions/checkout@v4
-      - uses: MarkPhamm/quickdbd-cli@v0.4.2
+      - uses: MarkPhamm/quickdbd-cli@v0.5.0
         with:
           path: erd/                  # schema file(s) or folder(s)
           output: site/index.html

{quickdbd_cli-0.4.2.dist-info → quickdbd_cli-0.5.0.dist-info}/RECORD

@@ -1,13 +1,13 @@
-quickdbd_cli/__init__.py,sha256=6hfVa12Q-nXyUEXr6SyKpqPEDJW6vlRHyPxlA27PfTs,22
+quickdbd_cli/__init__.py,sha256=LBK46heutvn3KmsCrKIYu8RQikbfnjZaj2xFrXaeCzQ,22
 quickdbd_cli/__main__.py,sha256=E6Gls0DNz8GQK2K-kOUIx8cYhgANW_CH54VKrfCfs14,52
 quickdbd_cli/agent.py,sha256=LEuReTkwWDlRLs-GfQQMpMosHDFWbin0EAXRo73j-dA,37202
-quickdbd_cli/cli.py,sha256=kphlsJHzp-agb01rlw4PD2_SnriOtr-yRZPuW3I5B_E,30634
+quickdbd_cli/cli.py,sha256=zP9wnA_gcLZQ1bt3YCVt14V87fYmdgzsmDpi8E_0g3Y,33862
 quickdbd_cli/convert.py,sha256=1AYFm4YmEav_wZp7xCAcL7TsD3qC17Y1I5g6V_fyAU0,16682
 quickdbd_cli/dbml.py,sha256=tHJOtMm1PHx4-yqs6rncPqdDfbwPcW8F54j_kKlWkx0,59413
 quickdbd_cli/dbt.py,sha256=AMHzERmc8WfL1tBLX4bJdPVghIHrqrfx8nMDbZMrueY,23100
 quickdbd_cli/diff.py,sha256=UBiCE3dk_cN-xSRZFQoLiIIFh_FAVZUpLwsdtHG9eBo,9986
 quickdbd_cli/export.py,sha256=XbSvWqFmhQHPcBtPHPit1SmhJ6qXrPyGlHYt7FpIMyo,3539
-quickdbd_cli/html.py,sha256=eZSECAaP-vxC_qGXOy0T7cXT7WkJeL7RixYvzMCDCZQ,8309
+quickdbd_cli/html.py,sha256=tcbxiUmKhKfpAb7Pke1AVSRPK5VWaw9znpOi_3mQkoQ,9634
 quickdbd_cli/jsrt.py,sha256=_sRkmUbgHDTwK272jeTNUwojfjUKAkv4UeD2E2u3H1A,3464
 quickdbd_cli/layout.py,sha256=2wrryJ-SSJbMlOdxmtCTzC2_zkTtvRVs-OuOBS1bGEQ,10856
 quickdbd_cli/mcp.py,sha256=ibUg1a50BBco-hZABdxTexGZi_gclFCdcBDalTvFar8,12350
@@ -28,16 +28,16 @@ quickdbd_cli/assets/editor.js,sha256=Gare_MeAOKlc2QZpTR9nD8Ty-U6JBY3HRWAeMnDkCsU
 quickdbd_cli/assets/elk-LICENSE.md,sha256=Y36B9KG2tAeVNcSZ_KBeI4z3YFwf9bdtYNfafOlnAMk,14443
 quickdbd_cli/assets/elk.bundled.js,sha256=EiLkT5U853Rq8jgB5yNwj45vQ2uLN3pqX8dVLzSjB7M,1609707
 quickdbd_cli/assets/font-metrics.json,sha256=sXSiElxQSK8md8IEePLwh16TTdAqKt9rV140pvMlVS8,8654
-quickdbd_cli/assets/icon.svg,sha256=0T_BOpEdFzxQHg6wJL2rrEyk55nkjascmp_3xBE9IA0,338
+quickdbd_cli/assets/icon.svg,sha256=z1KKpKN3dJbESzbC1EDS3NYOj9aKQw1pJfzwXFPg_M0,338
 quickdbd_cli/assets/render.js,sha256=WzxX_sUgdz0O4GgiaupKl8J_LI4YCqF9PUxzRbwebwo,31891
-quickdbd_cli/assets/style.css,sha256=ttyGKLti1sU-NMp9CBTDgaznfeU14XjWquFJr9XGsaA,18877
+quickdbd_cli/assets/style.css,sha256=mTkpexDcMilBtds2WRk6SYiCrIA1DpZLueKmm3pRQw0,18877
 quickdbd_cli/assets/syntax-reference.md,sha256=WERcsWjyrfeHQPgxQriWKBsqFJnmWTQ2oRZjKYAHhKc,5322
 quickdbd_cli/assets/viewer.js,sha256=3rKXI80TNv9jF1dJNQa3Gpy0042yTcGfTz_8qg4h5WU,49676
-quickdbd_cli-0.4.2.dist-info/METADATA,sha256=uC4ifoOto5S6EsvclQEyw-e_72Kt4A-jAb61_S05cq8,17704
-quickdbd_cli-0.4.2.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
-quickdbd_cli-0.4.2.dist-info/entry_points.txt,sha256=nRhiYYug-XOY95nWUmi4oanico3Zjkfqk2OHtIE6SQ0,47
-quickdbd_cli-0.4.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-quickdbd_cli-0.4.2.dist-info/licenses/NOTICE,sha256=pyv3BfIYiGzKLU4w-GcBe7GXoXxHqZ97Mf6Zpx_3_i0,2067
-quickdbd_cli-0.4.2.dist-info/licenses/src/quickdbd_cli/assets/Inter-LICENSE.txt,sha256=JiSB6ERSGzJvXs0FPlm5jIstp4yO4b27boF0MF5Uk1o,4380
-quickdbd_cli-0.4.2.dist-info/licenses/src/quickdbd_cli/assets/elk-LICENSE.md,sha256=Y36B9KG2tAeVNcSZ_KBeI4z3YFwf9bdtYNfafOlnAMk,14443
-quickdbd_cli-0.4.2.dist-info/RECORD,,
+quickdbd_cli-0.5.0.dist-info/METADATA,sha256=NjeLisXVxAEYPnC53QjQpJv0IUrwcJgiYHHjf1BNfiw,17704
+quickdbd_cli-0.5.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+quickdbd_cli-0.5.0.dist-info/entry_points.txt,sha256=nRhiYYug-XOY95nWUmi4oanico3Zjkfqk2OHtIE6SQ0,47
+quickdbd_cli-0.5.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+quickdbd_cli-0.5.0.dist-info/licenses/NOTICE,sha256=pyv3BfIYiGzKLU4w-GcBe7GXoXxHqZ97Mf6Zpx_3_i0,2067
+quickdbd_cli-0.5.0.dist-info/licenses/src/quickdbd_cli/assets/Inter-LICENSE.txt,sha256=JiSB6ERSGzJvXs0FPlm5jIstp4yO4b27boF0MF5Uk1o,4380
+quickdbd_cli-0.5.0.dist-info/licenses/src/quickdbd_cli/assets/elk-LICENSE.md,sha256=Y36B9KG2tAeVNcSZ_KBeI4z3YFwf9bdtYNfafOlnAMk,14443
+quickdbd_cli-0.5.0.dist-info/RECORD,,