quickdbd-cli 0.1.0__tar.gz → 0.1.1__tar.gz

{quickdbd_cli-0.1.0 → quickdbd_cli-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: quickdbd-cli
-Version: 0.1.0
+Version: 0.1.1
 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
@@ -148,6 +148,17 @@ python scripts/gen_font_metrics.py  # regenerate font width table
 
 Design notes: `docs/superpowers/specs/2026-10-17-qdbd-design.md`.
 
+### Releasing
+
+Put PyPI credentials in `.env` (gitignored):
+
+```
+TWINE_USERNAME=__token__
+TWINE_PASSWORD=pypi-...
+```
+
+Bump `version` in `pyproject.toml` and `src/quickdbd_cli/__init__.py`, commit, then run `scripts/release.sh`. It builds, uploads to PyPI, tags `vX.Y.Z` and creates the GitHub release.
+
 ## License
 
 Apache-2.0. Bundled third-party files are listed in [NOTICE](NOTICE).

{quickdbd_cli-0.1.0 → quickdbd_cli-0.1.1}/README.md

@@ -123,6 +123,17 @@ python scripts/gen_font_metrics.py  # regenerate font width table
 
 Design notes: `docs/superpowers/specs/2026-10-17-qdbd-design.md`.
 
+### Releasing
+
+Put PyPI credentials in `.env` (gitignored):
+
+```
+TWINE_USERNAME=__token__
+TWINE_PASSWORD=pypi-...
+```
+
+Bump `version` in `pyproject.toml` and `src/quickdbd_cli/__init__.py`, commit, then run `scripts/release.sh`. It builds, uploads to PyPI, tags `vX.Y.Z` and creates the GitHub release.
+
 ## License
 
 Apache-2.0. Bundled third-party files are listed in [NOTICE](NOTICE).

{quickdbd_cli-0.1.0 → quickdbd_cli-0.1.1}/examples/synthetic/qdbd.layout.json

@@ -29,8 +29,8 @@
       "y": 5795
     },
     "Agency": {
-      "x": 573,
-      "y": 3287
+      "x": 603,
+      "y": 3752
     },
     "Allocation": {
       "x": 1655,
@@ -245,8 +245,8 @@
       "y": 5393
     },
     "EmailOpen": {
-      "x": 3473,
-      "y": 2776
+      "x": 3395,
+      "y": 2767
     },
     "EmailSend": {
       "x": 1927,
@@ -325,8 +325,8 @@
       "y": 4608
     },
     "Holiday": {
-      "x": 3334,
-      "y": 3050
+      "x": 3280,
+      "y": 3035
     },
     "Impression": {
       "x": 2544,
@@ -393,8 +393,8 @@
       "y": 6657
     },
     "Ledger": {
-      "x": 3583,
-      "y": 2235
+      "x": 3541,
+      "y": 2427
     },
     "LedgerEntry": {
       "x": 2512,
@@ -573,16 +573,16 @@
       "y": 3695
     },
     "Reseller": {
-      "x": 3051,
-      "y": 2797
+      "x": 3043,
+      "y": 2791
     },
     "Reservation": {
       "x": 3614,
       "y": 1303
     },
     "Return": {
-      "x": 1231,
-      "y": 3991
+      "x": 1113,
+      "y": 3858
     },
     "Review": {
       "x": 604,
@@ -761,8 +761,8 @@
       "y": 5153
     },
     "hr.Training": {
-      "x": 1115,
-      "y": 4126
+      "x": 1357,
+      "y": 3813
     },
     "inventory.Container": {
       "x": 2503,

{quickdbd_cli-0.1.0 → quickdbd_cli-0.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "quickdbd-cli"
-version = "0.1.0"
+version = "0.1.1"
 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.1/scripts/release.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+# Build and upload the current version to PyPI using credentials from .env,
+# then tag and create the GitHub release.
+# Usage: bump `version` in pyproject.toml and src/quickdbd_cli/__init__.py, commit, then run scripts/release.sh
+set -euo pipefail
+cd "$(dirname "$0")/.."
+
+[ -f .env ] || { echo "error: .env with TWINE_USERNAME/TWINE_PASSWORD not found" >&2; exit 1; }
+set -a; . ./.env; set +a
+
+version=$(python3 -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+[ -z "$(git status --porcelain --untracked-files=no)" ] || { echo "error: uncommitted changes" >&2; exit 1; }
+
+rm -rf dist
+python3 -m pip install -q --upgrade build twine
+python3 -m build
+python3 -m twine check dist/*
+python3 -m twine upload --non-interactive dist/*
+
+git tag -a "v$version" -m "qdbd v$version"
+git push origin "v$version"
+gh release create "v$version" dist/* --title "qdbd v$version" --generate-notes
+echo "Released v$version: https://pypi.org/project/quickdbd-cli/$version/"

quickdbd_cli-0.1.1/src/quickdbd_cli/__init__.py

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

{quickdbd_cli-0.1.0 → quickdbd_cli-0.1.1}/src/quickdbd_cli/assets/viewer.js

@@ -288,7 +288,7 @@
   }
   function exportSvg() {
     var only = S.focus ? Object.keys(neighbours(S.focus)) : null;
-    return Q.renderSvg(S.model, S.pos, { mode: S.mode, only: only, fontCss: data.fontCss });
+    return Q.renderSvg(S.model, S.pos, { mode: S.mode, only: only, fontCss: document.getElementById("qdbd-font").textContent });
   }
   document.getElementById("xsvg").onclick = function () {
     download((data.title || "diagram") + ".svg", new Blob([exportSvg()], { type: "image/svg+xml" }));

{quickdbd_cli-0.1.0 → quickdbd_cli-0.1.1}/src/quickdbd_cli/html.py

@@ -67,7 +67,7 @@ SIDE = """
 
 
 def render_page(model: dict, positions: dict, title: str, serve: bool = False) -> str:
-    data = {"model": model, "positions": positions, "serve": serve, "title": title, "fontCss": font_css()}
+    data = {"model": model, "positions": positions, "serve": serve, "title": title}
     hint = (
         "Drag tables to move them (saved). Click a table to focus. Esc clears."
         if serve
@@ -88,7 +88,10 @@ def render_page(model: dict, positions: dict, title: str, serve: bool = False) -
         '<meta name="viewport" content="width=device-width, initial-scale=1">'
         '<meta name="generator" content="qdbd">'
         f"<title>{_escape(title)}</title>"
-        f"<style>{font_css()}{_asset('style.css')}</style>{head_extra}</head><body>"
+        # The font CSS lives in its own <style> so the viewer can reuse it for SVG/PNG export
+        # instead of embedding the fonts a second time.
+        f'<style id="qdbd-font">{font_css()}</style>'
+        f"<style>{_asset('style.css')}</style>{head_extra}</head><body>"
         f"{body}"
         f'<script type="application/json" id="qdbd-data">{_json_for_script(data)}</script>'
         f"<script>{_asset('render.js')}</script>"

{quickdbd_cli-0.1.0 → quickdbd_cli-0.1.1}/src/quickdbd_cli/serve.py

@@ -178,13 +178,30 @@ def _handler(state: State, title: str):
     return Handler
 
 
-def serve(project: Project, port: int = 8765, open_browser: bool = True) -> int:
+def make_server(project: Project, port: int = 8765) -> tuple[ThreadingHTTPServer, State]:
+    """Bind the HTTP server (port 0 picks a free port) without starting it."""
     state = State(project)
-    for d in state.diagnostics:
-        print(d["text"], file=sys.stderr)
     title = project.inputs[0].stem if len(project.inputs) == 1 else "diagram"
     server = ThreadingHTTPServer(("127.0.0.1", port), _handler(state, title))
     server.daemon_threads = True
+    return server, state
+
+
+def poll_once(state: State) -> bool:
+    """Reload if any schema file changed; returns True when a reload happened."""
+    if not state.changed():
+        return False
+    try:
+        state.reload()
+    except Exception as e:  # keep serving on unexpected errors
+        print(f"[qdbd] reload failed: {e}", file=sys.stderr, flush=True)
+    return True
+
+
+def serve(project: Project, port: int = 8765, open_browser: bool = True) -> int:
+    server, state = make_server(project, port)
+    for d in state.diagnostics:
+        print(d["text"], file=sys.stderr)
     url = f"http://127.0.0.1:{server.server_address[1]}/"
     print(f"[qdbd] serving {len(state.files)} file(s) at {url}  (layout: {display_path(project.sidecar)})")
     print("[qdbd] Ctrl+C to stop", flush=True)
@@ -192,11 +209,7 @@ def serve(project: Project, port: int = 8765, open_browser: bool = True) -> int:
     def watch() -> None:
         while True:
             time.sleep(0.3)
-            if state.changed():
-                try:
-                    state.reload()
-                except Exception as e:  # keep serving on unexpected errors
-                    print(f"[qdbd] reload failed: {e}", file=sys.stderr, flush=True)
+            poll_once(state)
 
     threading.Thread(target=watch, daemon=True).start()
     if open_browser:

{quickdbd_cli-0.1.0 → quickdbd_cli-0.1.1}/tests/test_pipeline.py

@@ -8,6 +8,7 @@ import pytest
 
 from quickdbd_cli import export, layout
 from quickdbd_cli.cli import main
+from quickdbd_cli.html import render_page
 from quickdbd_cli.measure import model_json, text_width
 from quickdbd_cli.parser import compile_text
 from quickdbd_cli.project import Project
@@ -138,6 +139,7 @@ def test_check_strict_warnings(tmp_path):
 def test_build_is_deterministic_and_does_not_write_sidecar(tmp_path):
     work = tmp_path / "s"
     shutil.copytree(SYNTH, work)
+    (work / "qdbd.layout.json").unlink(missing_ok=True)
     a, b = tmp_path / "a.html", tmp_path / "b.html"
     assert main(["build", str(work), "-o", str(a)]) == 0
     assert main(["build", str(work), "-o", str(b)]) == 0
@@ -159,6 +161,24 @@ def test_layout_command_writes_sidecar_and_reset(tmp_path):
     assert json.loads(side.read_text())["tables"]["Customer"] != {"x": 9999, "y": 9999}
 
 
+def test_build_uses_but_never_rewrites_committed_sidecar(tmp_path):
+    work = tmp_path / "s"
+    shutil.copytree(SYNTH, work)
+    side = work / "qdbd.layout.json"
+    before = side.read_bytes()
+    assert main(["build", str(work), "-o", str(tmp_path / "d.html")]) == 0
+    assert side.read_bytes() == before
+    html = (tmp_path / "d.html").read_text()
+    customer = layout.read_sidecar(side)["Customer"]
+    assert f'"Customer":[{customer[0]},{customer[1]}]' in html
+
+
+def test_html_embeds_font_once():
+    html = render_page(model_json(compile_text(SMALL)), {"Customer": [0, 0], "Order": [300, 0]}, "t")
+    assert html.count("@font-face") == 2  # regular + bold, once each
+    assert 'id="qdbd-font"' in html
+
+
 def test_missing_path(capsys):
     assert main(["check", "nope/does-not-exist.txt"]) == 2
 

quickdbd_cli-0.1.1/tests/test_serve.py

@@ -0,0 +1,160 @@
+"""`qdbd serve` HTTP endpoints, driven without a browser."""
+
+import json
+import os
+import threading
+import time
+import urllib.error
+import urllib.request
+
+import pytest
+
+from quickdbd_cli import layout
+from quickdbd_cli.project import Project, display_path
+from quickdbd_cli.serve import make_server, poll_once
+
+SCHEMA = """Customer
+-
+CustomerId PK int
+Name string
+
+Order
+-
+OrderId PK int
+CustomerId int FK >- Customer.CustomerId
+"""
+
+
+@pytest.fixture
+def srv(tmp_path):
+    f = tmp_path / "shop.txt"
+    f.write_text(SCHEMA)
+    server, state = make_server(Project.open([f]), port=0)
+    t = threading.Thread(target=server.serve_forever, daemon=True)
+    t.start()
+    base = f"http://127.0.0.1:{server.server_address[1]}"
+    yield base, state, f
+    server.shutdown()
+    server.server_close()
+
+
+def call(base, path, method="GET", body=None):
+    data = json.dumps(body).encode() if body is not None else None
+    req = urllib.request.Request(base + path, data=data, method=method, headers={"Content-Type": "application/json"})
+    try:
+        with urllib.request.urlopen(req, timeout=10) as r:
+            raw = r.read()
+            return r.status, (json.loads(raw) if r.headers.get_content_type() == "application/json" else raw)
+    except urllib.error.HTTPError as e:
+        return e.code, json.loads(e.read())
+
+
+def bump_mtime(path):
+    st = path.stat()
+    os.utime(path, ns=(st.st_atime_ns, st.st_mtime_ns + 1_000_000_000))
+
+
+def test_page_and_state(srv):
+    base, _, f = srv
+    code, page = call(base, "/")
+    assert code == 200 and b'id="side"' in page and b'"serve":true' in page
+    code, st = call(base, "/state")
+    assert code == 200
+    assert [t["name"] for t in st["model"]["tables"]] == ["Customer", "Order"]
+    assert st["files"] == [{"path": display_path(f), "text": SCHEMA, "mtime": st["files"][0]["mtime"]}]
+    assert isinstance(st["files"][0]["mtime"], str)  # ns mtimes overflow JS numbers
+    assert st["diagnostics"] == []
+
+
+def test_initial_layout_written_to_sidecar(srv):
+    _, state, f = srv
+    side = layout.read_sidecar(f.with_name("shop.layout.json"))
+    assert set(side) == {"Customer", "Order"}
+
+
+def test_put_file_saves_and_returns_new_mtime(srv):
+    base, _, f = srv
+    _, st = call(base, "/state")
+    path, mtime = st["files"][0]["path"], st["files"][0]["mtime"]
+    new = SCHEMA + "\nProduct\n-\nProductId PK int\n"
+    code, res = call(base, "/file", "PUT", {"path": path, "text": new, "mtime": mtime})
+    assert code == 200 and res["mtime"] != mtime
+    assert f.read_text() == new
+
+
+def test_put_file_refuses_stale_write(srv):
+    base, _, f = srv
+    _, st = call(base, "/state")
+    path, mtime = st["files"][0]["path"], st["files"][0]["mtime"]
+    f.write_text(SCHEMA + "\n# edited elsewhere\n")
+    bump_mtime(f)
+    code, res = call(base, "/file", "PUT", {"path": path, "text": "clobber", "mtime": mtime})
+    assert code == 409
+    assert "# edited elsewhere" in res["text"]
+    assert "# edited elsewhere" in f.read_text()  # disk untouched
+
+
+def test_put_unknown_file(srv):
+    base, _, _ = srv
+    code, _ = call(base, "/file", "PUT", {"path": "nope.txt", "text": "x", "mtime": None})
+    assert code == 404
+
+
+def test_post_layout_updates_sidecar(srv):
+    base, state, f = srv
+    code, _ = call(base, "/layout", "POST", {"Customer": [1234, 567], "Unknown": [1, 1]})
+    assert code == 200
+    side = layout.read_sidecar(f.with_name("shop.layout.json"))
+    assert side["Customer"] == (1234, 567)
+    assert "Unknown" not in side
+    _, st = call(base, "/state")
+    assert st["positions"]["Customer"] == [1234, 567]
+
+
+def test_external_edit_reloads_and_places_new_table(srv):
+    base, state, f = srv
+    _, before = call(base, "/state")
+    f.write_text(SCHEMA + "\nLine\n-\nLineId PK int\nOrderId int FK >- Order.OrderId\n")
+    bump_mtime(f)
+    assert poll_once(state)
+    _, after = call(base, "/state")
+    assert after["version"] > before["version"]
+    assert "Line" in after["positions"]
+    # existing tables did not move
+    for t in ("Customer", "Order"):
+        assert after["positions"][t] == before["positions"][t]
+    assert not poll_once(state)  # nothing changed since
+
+
+def test_errors_keep_last_good_model(srv):
+    base, state, f = srv
+    f.write_text(SCHEMA + "\nBad\n-\nX int FK >- Nope.Id\n")
+    bump_mtime(f)
+    poll_once(state)
+    _, st = call(base, "/state")
+    assert [d["severity"] for d in st["diagnostics"]] == ["error"]
+    assert "Invalid relationship, the table 'Nope' does not exist" in st["diagnostics"][0]["text"]
+    assert [t["name"] for t in st["model"]["tables"]] == ["Customer", "Order"]
+
+
+def test_events_stream_announces_versions(srv):
+    base, state, f = srv
+    got = []
+
+    def listen():
+        with urllib.request.urlopen(base + "/events", timeout=10) as r:
+            for line in r:
+                line = line.decode().strip()
+                if line.startswith("data:"):
+                    got.append(int(line[5:]))
+                    if len(got) == 2:
+                        return
+
+    t = threading.Thread(target=listen, daemon=True)
+    t.start()
+    time.sleep(0.3)
+    f.write_text(SCHEMA + "\n# touch\n")
+    bump_mtime(f)
+    poll_once(state)
+    t.join(timeout=10)
+    assert len(got) == 2 and got[1] > got[0]

quickdbd_cli-0.1.0/src/quickdbd_cli/__init__.py

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