quickdbd-cli 0.3.2__tar.gz → 0.3.4__tar.gz

{quickdbd_cli-0.3.2 → quickdbd_cli-0.3.4}/.gitignore

@@ -222,3 +222,4 @@ __marimo__/
 .superpowers/
 site/
 jaffle-erd/
+graphify-out/

{quickdbd_cli-0.3.2 → quickdbd_cli-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: quickdbd-cli
-Version: 0.3.2
+Version: 0.3.4
 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/
@@ -43,7 +43,7 @@ Description-Content-Type: text/markdown
   </picture>
 </p>
 
-<p align="center"><b>Interactive ER diagrams from QuickDBD text or a dbt project, readable at 200+ tables</b></p>
+<p align="center"><b>Interactive ER diagrams from QuickDBD text, DBML or a dbt project, readable at 200+ tables</b></p>
 
 <p align="center">
   <a href="https://pypi.org/project/quickdbd-cli/"><img src="https://img.shields.io/pypi/v/quickdbd-cli?label=PyPI" alt="PyPI version"></a>
@@ -89,7 +89,7 @@ qdbd is not affiliated with QuickDBD or dbdiagram.io. It reads the same text syn
 - **QuickDBD-compatible**: the parser mirrors QuickDBD's own, error messages included. A file that passes `qdbd check --strict` pastes into QuickDBD unchanged.
 - **dbt import**: `qdbd import dbt` reads `manifest.json`. Primary keys come from `unique` + `not_null` tests or constraints, relationships from `relationships` tests, and `--infer-fks` fills the gaps from column names.
 - **Readable at 200+ tables**: automatic layout, search, dbt-style selectors (`+orders+1`, `group:marts`, `tag:fact`), shaded regions per file, collapsed views and a minimap.
-- **Review changes in pull requests**: `qdbd diff` reports what a branch changed, the GitHub Action posts it as a PR comment, and `--diff-base` colours the changes in the diagram.
+- **Review changes in pull requests**: `qdbd diff` reports what a branch changed, the GitHub Action posts it as a PR comment, and `--diff-base` colours the changes in the diagram. To propose a column change, tag the column `# @tag: added` or `# @tag: removed` and it's drawn green or red ([column tags](https://qdbd.dev/tags/#columns)).
 - **VS Code extension**: highlighting, errors as you type, outline, F12 across files, and the diagram beside the editor, following your cursor, or in your browser on localhost. Export, share, compare with git, convert to and from DBML, and dbt import from the sidebar or the Command Palette, with no terminal: it installs the CLI itself. Get it from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=MarkPhamm.quickdbd) or, for Cursor, Windsurf and VSCodium, [Open VSX](https://open-vsx.org/extension/MarkPhamm/quickdbd) ([docs](https://qdbd.dev/vscode/)).
 - **AI agents**: `qdbd mcp` gives Claude, Copilot and Cursor your schema as tools: tables and columns, join paths as SQL (composite keys included), checks for their edits and diffs against `main` ([docs](https://qdbd.dev/mcp/)).
 - **One schema, many outputs**: an HTML page, PNG, SVG, editable draw.io, or a shareable link. Installs with pip: no Node, Graphviz or browser needed.
@@ -186,7 +186,7 @@ jobs:
     permissions: { contents: read, pull-requests: write }
     steps:
       - uses: actions/checkout@v4
-      - uses: MarkPhamm/quickdbd-cli@v0.1.11
+      - uses: MarkPhamm/quickdbd-cli@v0.3.4
         with:
           path: erd/                  # schema file(s) or folder(s)
           output: site/index.html
@@ -198,7 +198,7 @@ dbt projects, GitHub Pages, pre-commit and GitLab CI are covered in [CI and Auto
 
 ```text
 dbt project ──qdbd import dbt──┐
-                               ├──▶ schema/*.txt   (QuickDBD syntax, in git)
+                               ├──▶ schema/*.txt, *.dbml   (QuickDBD syntax or DBML, in git)
 hand-written / pasted ─────────┘           │
                                            ├──▶ qdbd check   validation, QuickDBD's error messages  ──▶ CI gate
                                            ├──▶ qdbd serve   live editor, drag to arrange           ──▶ schema.layout.json
@@ -240,7 +240,7 @@ qdbd build schema/ -o erd.html
 
 | | qdbd | QuickDBD |
 |---|---|---|
-| Text syntax | QuickDBD's | QuickDBD's |
+| Text syntax | QuickDBD's or DBML | QuickDBD's |
 | Tables per diagram | no limit | 10 on the free plan |
 | Where it runs | your terminal and CI; the result is a static HTML file | the QuickDBD web app |
 | Where the schema lives | `.txt` / `.dbml` files in your git repo | the web app |

{quickdbd_cli-0.3.2 → quickdbd_cli-0.3.4}/README.md

@@ -5,7 +5,7 @@
   </picture>
 </p>
 
-<p align="center"><b>Interactive ER diagrams from QuickDBD text or a dbt project, readable at 200+ tables</b></p>
+<p align="center"><b>Interactive ER diagrams from QuickDBD text, DBML or a dbt project, readable at 200+ tables</b></p>
 
 <p align="center">
   <a href="https://pypi.org/project/quickdbd-cli/"><img src="https://img.shields.io/pypi/v/quickdbd-cli?label=PyPI" alt="PyPI version"></a>
@@ -51,7 +51,7 @@ qdbd is not affiliated with QuickDBD or dbdiagram.io. It reads the same text syn
 - **QuickDBD-compatible**: the parser mirrors QuickDBD's own, error messages included. A file that passes `qdbd check --strict` pastes into QuickDBD unchanged.
 - **dbt import**: `qdbd import dbt` reads `manifest.json`. Primary keys come from `unique` + `not_null` tests or constraints, relationships from `relationships` tests, and `--infer-fks` fills the gaps from column names.
 - **Readable at 200+ tables**: automatic layout, search, dbt-style selectors (`+orders+1`, `group:marts`, `tag:fact`), shaded regions per file, collapsed views and a minimap.
-- **Review changes in pull requests**: `qdbd diff` reports what a branch changed, the GitHub Action posts it as a PR comment, and `--diff-base` colours the changes in the diagram.
+- **Review changes in pull requests**: `qdbd diff` reports what a branch changed, the GitHub Action posts it as a PR comment, and `--diff-base` colours the changes in the diagram. To propose a column change, tag the column `# @tag: added` or `# @tag: removed` and it's drawn green or red ([column tags](https://qdbd.dev/tags/#columns)).
 - **VS Code extension**: highlighting, errors as you type, outline, F12 across files, and the diagram beside the editor, following your cursor, or in your browser on localhost. Export, share, compare with git, convert to and from DBML, and dbt import from the sidebar or the Command Palette, with no terminal: it installs the CLI itself. Get it from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=MarkPhamm.quickdbd) or, for Cursor, Windsurf and VSCodium, [Open VSX](https://open-vsx.org/extension/MarkPhamm/quickdbd) ([docs](https://qdbd.dev/vscode/)).
 - **AI agents**: `qdbd mcp` gives Claude, Copilot and Cursor your schema as tools: tables and columns, join paths as SQL (composite keys included), checks for their edits and diffs against `main` ([docs](https://qdbd.dev/mcp/)).
 - **One schema, many outputs**: an HTML page, PNG, SVG, editable draw.io, or a shareable link. Installs with pip: no Node, Graphviz or browser needed.
@@ -148,7 +148,7 @@ jobs:
     permissions: { contents: read, pull-requests: write }
     steps:
       - uses: actions/checkout@v4
-      - uses: MarkPhamm/quickdbd-cli@v0.1.11
+      - uses: MarkPhamm/quickdbd-cli@v0.3.4
         with:
           path: erd/                  # schema file(s) or folder(s)
           output: site/index.html
@@ -160,7 +160,7 @@ dbt projects, GitHub Pages, pre-commit and GitLab CI are covered in [CI and Auto
 
 ```text
 dbt project ──qdbd import dbt──┐
-                               ├──▶ schema/*.txt   (QuickDBD syntax, in git)
+                               ├──▶ schema/*.txt, *.dbml   (QuickDBD syntax or DBML, in git)
 hand-written / pasted ─────────┘           │
                                            ├──▶ qdbd check   validation, QuickDBD's error messages  ──▶ CI gate
                                            ├──▶ qdbd serve   live editor, drag to arrange           ──▶ schema.layout.json
@@ -202,7 +202,7 @@ qdbd build schema/ -o erd.html
 
 | | qdbd | QuickDBD |
 |---|---|---|
-| Text syntax | QuickDBD's | QuickDBD's |
+| Text syntax | QuickDBD's or DBML | QuickDBD's |
 | Tables per diagram | no limit | 10 on the free plan |
 | Where it runs | your terminal and CI; the result is a static HTML file | the QuickDBD web app |
 | Where the schema lives | `.txt` / `.dbml` files in your git repo | the web app |

{quickdbd_cli-0.3.2 → quickdbd_cli-0.3.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "quickdbd-cli"
-version = "0.3.2"
+version = "0.3.4"
 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.3.4/src/quickdbd_cli/__init__.py

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

{quickdbd_cli-0.3.2 → quickdbd_cli-0.3.4}/src/quickdbd_cli/agent.py

@@ -638,12 +638,6 @@ def diff_schema(ws: Workspace, args: dict) -> Result:
     return Result("\n".join(clip(_header(c) + text.splitlines(), "lines")))
 
 
-def _svg_size(svg: str) -> tuple[float, float]:
-    w = re.search(r'\bwidth="([\d.]+)', svg)
-    h = re.search(r'\bheight="([\d.]+)', svg)
-    return (float(w.group(1)) if w else 1000.0, float(h.group(1)) if h else 1000.0)
-
-
 def render_diagram(ws: Workspace, args: dict) -> Result:
     c = ws.compile(ws.target(args.get("project")))
     tables = selected(c, args.get("select"))
@@ -679,7 +673,7 @@ def render_diagram(ws: Workspace, args: dict) -> Result:
             raise ToolError("the layout took too long; narrow with `select` or `focus`") from None
         pos = {k: [v[0], v[1]] for k, v in laid.items()}
         svg = export.render_svg(c.model, pos, only=ids, mode=mode, embed_font=False)
-        scale = min(2.0, IMAGE_SIDE / max(_svg_size(svg)))
+        scale = min(2.0, IMAGE_SIDE / max(export.svg_size(svg)))
         if scale >= MIN_SCALE[mode]:
             png = export.svg_to_png(svg, scale)
             names = ", ".join(t["name"] for t in tables[:40]) + (", …" if n > 40 else "")

{quickdbd_cli-0.3.2 → quickdbd_cli-0.3.4}/src/quickdbd_cli/assets/render.js

@@ -547,6 +547,54 @@
     return lines.join("\n");
   }
 
+  /* ------------------------------------------------------------------ lit relationships (viewer only, never exported) */
+  var CARD_LABEL = { one: "1", zeroOne: "0..1", many: "*", zeroMany: "0..*" };
+  var CARD_WORD = { one: "one", zeroOne: "zero or one", many: "many", zeroMany: "zero or many" };
+
+  /* Cardinality labels for a lit line: one just past each end, on the side the line leaves from. a end first. */
+  function edgeLabels(model, pos, mode, rel, geo) {
+    var e = edgeGeom(model, geo || geometry(model, mode), pos, rel);
+    if (!e) return null;
+    function spot(x, y, dir, card) {
+      return { x: n(x + dir * 8), y: n(y - 9), anchor: dir > 0 ? "start" : "end", text: CARD_LABEL[card] || "" };
+    }
+    return [spot(e.xa, e.ya, e.da, rel.a.card), spot(e.xb, e.yb, e.db, rel.b.card)];
+  }
+
+  /* Text of the relationship card for model.rels[i]: the child (FK / many) side first, a plain-English sentence and
+   * the JOIN, built like `qdbd path` so quoting and composite keys match. */
+  function relCard(model, i) {
+    var r = model.rels[i], byId = {};
+    model.tables.forEach(function (t) { byId[t.id] = t; });
+    var aMany = r.a.card === "many" || r.a.card === "zeroMany", bMany = r.b.card === "many" || r.b.card === "zeroMany";
+    var aIsChild = aMany || !bMany, child = aIsChild ? r.a : r.b, parent = aIsChild ? r.b : r.a;
+    var pairs = stepPairs(model, i, child.t);
+    function side(end, k) {
+      var t = byId[end.t], cols = pairs.map(function (p) {
+        var c = t.cols.filter(function (x) { return x.id === p[k]; })[0];
+        return c ? c.name : p[k];
+      });
+      return t.name + (cols.length > 1 ? ".(" + cols.join(", ") + ")" : cols.length ? "." + cols[0] : "");
+    }
+    var plural = child.card === "many" || child.card === "zeroMany";
+    return {
+      from: side(child, 0),
+      to: side(parent, 1),
+      cardFrom: CARD_LABEL[child.card] || "",
+      cardTo: CARD_LABEL[parent.card] || "",
+      sentence: "Each " + byId[parent.t].name + " row has " + CARD_WORD[child.card] + " " + byId[child.t].name + (plural ? " rows" : " row"),
+      sql: child.t === parent.t ? selfJoin(byId[child.t], pairs) : pathSql(model, child.t, [{ from: child, to: parent, pairs: pairs }]),
+    };
+  }
+  /* A table joined to itself needs an alias, or every column is ambiguous. */
+  function selfJoin(t, pairs) {
+    var name = sqlIdent(t.name), alias = sqlPart(t.name.split(".").pop() + "_2");
+    function col(c) { var x = t.cols.filter(function (k) { return k.id === c; })[0]; return sqlPart(x ? x.name : c); }
+    var on = pairs.map(function (p) { return alias + "." + col(p[1]) + " = " + name + "." + col(p[0]); });
+    return "FROM " + name + "\nJOIN " + name + " AS " + alias + " ON " +
+      (on.length ? on.join(" AND ") : "...  -- table-level relationship: join columns not specified");
+  }
+
   root.qdbd = {
     findPath: findPath,
     stepPairs: stepPairs,
@@ -563,8 +611,12 @@
     renderSvg: renderSvg,
     bounds: bounds,
     neighbourhood: neighbourhood,
+    edgeLabels: edgeLabels,
+    relCard: relCard,
     esc: esc,
   };
+  root.qdbdEdgeLabels = edgeLabels;
+  root.qdbdRelCard = relCard;
   root.qdbdRenderSvg = renderSvg;
   root.qdbdSelect = select;
   root.qdbdRenderDrawio = renderDrawio;

{quickdbd_cli-0.3.2 → quickdbd_cli-0.3.4}/src/quickdbd_cli/assets/style.css

@@ -34,6 +34,8 @@
   --t-edge: #b8bcc2;
   --row-hl: #dbe6f6;
   --row-hover: #eef3fa;
+  --lit: #4361ee;
+  --lit-deep: #2a3fb8;
 }
 /* Dark theme. viewer.js sets data-theme from the toggle, or from prefers-color-scheme when it's on auto. */
 :root[data-theme="dark"] {
@@ -71,6 +73,8 @@
   --t-edge: #5b6472;
   --row-hl: #24344d;
   --row-hover: #23282f;
+  --lit: #8aa0ff;
+  --lit-deep: #c3ceff;
 }
 ::selection { background: var(--pick); color: var(--ink); }
 :focus-visible { outline: 2px solid var(--amber); outline-offset: 1px; }
@@ -82,6 +86,7 @@ html, body { margin: 0; height: 100%; background: var(--bg); color: var(--ink);
 #stage { position: relative; flex: 1; overflow: hidden; }
 #canvas { width: 100%; height: 100%; display: block; cursor: grab; touch-action: none; user-select: none; }
 #canvas.panning { cursor: grabbing; }
+#canvas.lod .t text { display: none; } /* big diagram, zoomed out: see LOD_TABLES in viewer.js */
 
 /* diagram colours: CSS beats the SVG presentation attributes, so the page can theme them */
 .tb { fill: var(--t-body); stroke: var(--t-border); }
@@ -104,6 +109,36 @@ html, body { margin: 0; height: 100%; background: var(--bg); color: var(--ink);
 .r.hl .rb { fill: var(--row-hl); fill-opacity: 1; }
 .r:hover .rb { fill: var(--row-hover); fill-opacity: 1; }
 .t.flash .tb { stroke: #f0a020; stroke-width: 3; }
+.t .tb { transition: filter .18s; }
+.t:hover .tb { filter: drop-shadow(0 6px 14px rgba(16, 24, 40, .16)); }
+
+/* lit relationships: hovered or selected table, hovered or clicked line (viewer.js light()) */
+.e.lit .ep { stroke: var(--lit); stroke-width: 2.2; }
+.e.lit path, .e.lit .mc { stroke: var(--lit); }
+.r.lit .rb { fill: var(--row-hl); fill-opacity: 1; }
+.efocus .t:not(.on) { opacity: .18; }
+.efocus .e:not(.lit) { opacity: .07; }
+.fx { pointer-events: none; }
+.fx .flow { fill: none; stroke: var(--lit-deep); stroke-width: 4; stroke-dasharray: 4 18; animation: qdbd-flow 1.1s linear infinite; }
+.fx .flow.amber { stroke: #b86e00; }
+@keyframes qdbd-flow { to { stroke-dashoffset: -22; } }
+.fx .lbl { font: 600 11px Inter, "Helvetica Neue", Helvetica, Arial, sans-serif; fill: var(--lit); paint-order: stroke;
+  stroke: var(--bg); stroke-width: 4px; stroke-linejoin: round; animation: qdbd-fade .2s ease-out; }
+@keyframes qdbd-fade { from { opacity: 0; } }
+.hit path { fill: none; stroke: transparent; stroke-width: 14; pointer-events: stroke; cursor: pointer; }
+/* relationship card (a clicked line) */
+.rcard { position: absolute; z-index: 6; display: none; min-width: 240px; max-width: min(460px, calc(100% - 16px)); padding: 10px 12px;
+  background: var(--panel); border: 1px solid var(--line); border-radius: 10px; box-shadow: var(--shadow); font-size: 12px;
+  color: var(--ink); transform-origin: top left; }
+.rcard.open { display: block; animation: qdbd-cardin .16s ease-out; }
+@keyframes qdbd-cardin { from { opacity: 0; transform: scale(.96) translateY(-4px); } }
+.rcard .rt { font-weight: 600; margin-bottom: 2px; word-break: break-word; }
+.rcard .rt b { color: var(--lit); font-weight: 600; padding: 0 6px; white-space: nowrap; }
+.rcard .rk { color: var(--muted); margin-bottom: 8px; }
+.rcard pre { margin: 0 0 8px; padding: 7px 8px; background: var(--bg); border: 1px solid var(--line); border-radius: 7px;
+  font: 11px ui-monospace, Menlo, Consolas, monospace; white-space: pre-wrap; user-select: text; }
+.rcard .acts a { color: var(--blue); cursor: pointer; margin-right: 12px; }
+@media (prefers-reduced-motion: reduce) { .fx .flow, .fx .lbl, .rcard.open { animation: none; } }
 .t { cursor: grab; }
 #canvas.panning .t { cursor: grabbing; }
 
@@ -176,8 +211,10 @@ html, body { margin: 0; height: 100%; background: var(--bg); color: var(--ink);
 /* details drawer (right) */
 .details { position: absolute; top: 64px; right: 16px; bottom: 16px; width: 380px; background: var(--panel);
   border: 1px solid var(--line); border-radius: 10px; box-shadow: var(--shadow); overflow: auto;
-  display: none; z-index: 3; padding: 16px 18px; }
-.details.open { display: block; }
+  z-index: 3; padding: 16px 18px; visibility: hidden; opacity: 0; transform: translateX(16px); pointer-events: none;
+  transition: opacity .2s, transform .2s, visibility 0s .2s; }
+.details.open { visibility: visible; opacity: 1; transform: none; pointer-events: auto; transition: opacity .2s, transform .2s; }
+@media (prefers-reduced-motion: reduce) { .details, .details.open { transition: none; } }
 .has-details .minimap { right: 412px; }
 .details .close { position: absolute; top: 10px; right: 10px; width: 28px; height: 28px; border: 0; border-radius: 6px;
   background: transparent; display: flex; align-items: center; justify-content: center; color: var(--muted); cursor: pointer; }