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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: quickdbd-cli
-Version: 0.3.4
+Version: 0.3.5
 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/
@@ -186,7 +186,7 @@ jobs:
     permissions: { contents: read, pull-requests: write }
     steps:
       - uses: actions/checkout@v4
-      - uses: MarkPhamm/quickdbd-cli@v0.3.4
+      - uses: MarkPhamm/quickdbd-cli@v0.3.5
         with:
           path: erd/                  # schema file(s) or folder(s)
           output: site/index.html

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

@@ -148,7 +148,7 @@ jobs:
     permissions: { contents: read, pull-requests: write }
     steps:
       - uses: actions/checkout@v4
-      - uses: MarkPhamm/quickdbd-cli@v0.3.4
+      - uses: MarkPhamm/quickdbd-cli@v0.3.5
         with:
           path: erd/                  # schema file(s) or folder(s)
           output: site/index.html

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

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "quickdbd-cli"
-version = "0.3.4"
+version = "0.3.5"
 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 → quickdbd_cli-0.3.5}/scripts/build_gallery.py

@@ -19,7 +19,7 @@ from pathlib import Path
 from quickdbd_cli import __version__, diff
 from quickdbd_cli.dbt import import_dbt
 from quickdbd_cli.export import font_css
-from quickdbd_cli.html import _escape, _json_for_script, render_page
+from quickdbd_cli.html import _escape, _json_for_script, favicon, render_page
 from quickdbd_cli.parser import compile_sources
 from quickdbd_cli.project import Project
 
@@ -175,6 +175,7 @@ def gallery_page(catalog: Catalog, stats: dict[str, dict]) -> str:
     html = TEMPLATE.read_text(encoding="utf-8")
     return (
         html.replace("/*FONT_CSS*/", font_css())
+        .replace("<!--FAVICON-->", favicon())
         .replace("__VERSION__", _escape(__version__))
         .replace("__DATA__", _json_for_script(data))
     )

{quickdbd_cli-0.3.4 → quickdbd_cli-0.3.5}/scripts/gen_thumbnails.py

@@ -3,6 +3,7 @@
     python scripts/gen_thumbnails.py            # every demo
     python scripts/gen_thumbnails.py diff tags  # just these
     python scripts/gen_thumbnails.py hero       # the README hero (docs/assets/img/hero.png)
+    python scripts/gen_thumbnails.py path-sql   # the home page's path-to-SQL shot (docs/assets/img/path-sql.png)
 
 Dev-only: needs Playwright (`uv pip install -p .venv playwright`) and drives the system Chrome, so no
 browser download. Each demo is opened at its `view` + `shot` URL hash; the screenshot is framed in a card
@@ -24,6 +25,8 @@ from quickdbd_cli.html import _escape
 
 W, H = 1200, 630
 SHOT_W, SHOT_H = 1280, 820
+# The home page's "Every relationship is a JOIN" section; hooks/home.py asks join_path for the same two tables.
+PATH_SHOT = ("sakila", "t=payment&p=country")
 # Hidden in the screenshot: the table list, toolbar, minimap and hint. The details panel and diff bar stay.
 CLEAN = ".explorer, .bar, .minimap, .hint { display: none !important; }"
 
@@ -98,6 +101,20 @@ def main(argv: list[str]) -> int:
             dst = ROOT / "docs" / "assets" / "img" / "hero.png"
             page.screenshot(path=str(dst))
             print(f"Wrote {dst.relative_to(ROOT)}")
+        if "path-sql" in (set(argv) or {"path-sql"}):
+            page.set_viewport_size({"width": 1440, "height": 860})
+            page.goto((out / PATH_SHOT[0] / "index.html").as_uri() + f"#{PATH_SHOT[1]}")
+            page.wait_for_timeout(800)
+            page.get_by_text("Show only this path").click()
+            # the home page shows the SQL beside the shot, so the panel goes and the whole path shows
+            page.add_style_tag(content=".details, .hint { display: none !important; }")
+            page.click("#zfit")
+            page.click("#zout")  # fit counts tables only; the payment edge loops out to the right
+            page.mouse.move(700, 820)
+            page.wait_for_timeout(800)
+            dst = ROOT / "docs" / "assets" / "img" / "path-sql.png"
+            page.screenshot(path=str(dst))
+            print(f"Wrote {dst.relative_to(ROOT)}")
         browser.close()
     return 0
 

quickdbd_cli-0.3.5/src/quickdbd_cli/__init__.py

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

quickdbd_cli-0.3.5/src/quickdbd_cli/assets/icon.svg

@@ -0,0 +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>

{quickdbd_cli-0.3.4 → quickdbd_cli-0.3.5}/src/quickdbd_cli/html.py

@@ -4,6 +4,7 @@ from __future__ import annotations
 
 import json
 from importlib import resources
+from urllib.parse import quote
 
 from .export import font_css
 
@@ -14,6 +15,11 @@ def _asset(name: str) -> str:
     return resources.files("quickdbd_cli").joinpath(f"assets/{name}").read_text(encoding="utf-8")
 
 
+def favicon() -> str:
+    """The VS Code extension's icon as an inline SVG data URL, so pages stay single-file."""
+    return f'<link rel="icon" href="data:image/svg+xml,{quote(_asset("icon.svg").strip(), safe=" /=:")}">'
+
+
 def _json_for_script(obj) -> str:
     # Safe inside <script type="application/json">: no "</" sequences.
     return json.dumps(obj, sort_keys=True, separators=(",", ":"), ensure_ascii=False).replace("</", "<\\/")
@@ -171,6 +177,7 @@ def render_page(
         '<!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()}"
         f"<title>{_escape(title)}</title>"
         f"<script>{THEME_JS}</script>"
         # The font CSS lives in its own <style> so the viewer can reuse it for SVG/PNG export

{quickdbd_cli-0.3.4 → quickdbd_cli-0.3.5}/tests/test_pipeline.py

@@ -248,6 +248,8 @@ def test_build_is_deterministic_and_does_not_write_sidecar(tmp_path):
     assert not (work / "qdbd.layout.json").exists()
     html = a.read_text()
     assert "<title>s</title>" in html and '"serve":false' in html
+    # the VS Code icon, inline so the page stays one file
+    assert '<link rel="icon" href="data:image/svg+xml,%3Csvg ' in html
 
 
 def test_layout_command_writes_sidecar_and_reset(tmp_path):

quickdbd_cli-0.3.4/src/quickdbd_cli/__init__.py

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