quickdbd-cli 0.3.4__py3-none-any.whl → 0.4.0__py3-none-any.whl

quickdbd_cli/__init__.py

@@ -1 +1 @@
-__version__ = "0.3.4"
+__version__ = "0.4.0"

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/cli.py

@@ -158,10 +158,28 @@ def cmd_build(args) -> int:
 def cmd_share(args) -> int:
     from . import share
 
+    if not share.allowed():
+        print(
+            "error: sharing is off. qdbd share uploads the diagram (every table and column name) to a GitHub gist"
+            f" that anyone with the link can open. If your data policy allows that, set {share.ALLOW_ENV}=1"
+            " (doing so accepts https://qdbd.dev/sharing/#disclaimer).",
+            file=sys.stderr,
+        )
+        return 2
     res = _built_page(args)
     if isinstance(res, int):
         return res
     page, model = res
+    print(share.DISCLAIMER, file=sys.stderr)
+    if not args.yes:
+        if not sys.stdin.isatty():
+            print("error: no terminal to confirm in: add --yes to accept the disclaimer and share", file=sys.stderr)
+            return 2
+        kind = "public" if args.public else "secret"
+        print(f"Share {len(model['tables'])} tables as a {kind} gist? [y/N] ", end="", file=sys.stderr, flush=True)
+        if sys.stdin.readline().strip().lower() not in ("y", "yes"):
+            print("Not shared.", file=sys.stderr)
+            return 2
     key = share.share_key(args.paths, selector_expr(args.select, args.exclude))
     try:
         r = share.publish(page, _title(_open(args)), key, public=args.public, new=args.new)
@@ -571,7 +589,10 @@ def build_parser() -> argparse.ArgumentParser:
     sp.add_argument("--strict", action="store_true")
     sp.set_defaults(func=cmd_build)
 
-    sp = sub.add_parser("share", help="publish the diagram as a GitHub gist and print a link (needs the gh CLI)")
+    sp = sub.add_parser(
+        "share",
+        help="publish the diagram as a GitHub gist and print a link (off unless QDBD_ALLOW_SHARE=1; needs the gh CLI)",
+    )
     paths(sp)
     selectors(sp)
     sp.add_argument(
@@ -582,6 +603,7 @@ def build_parser() -> argparse.ArgumentParser:
     sp.add_argument("--strict", action="store_true")
     sp.add_argument("--public", action="store_true", help="list the gist publicly (default: secret, link-only)")
     sp.add_argument("--new", action="store_true", help="make a new gist instead of updating the last one")
+    sp.add_argument("-y", "--yes", action="store_true", help="accept the disclaimer without asking (for scripts)")
     sp.set_defaults(func=cmd_share)
 
     sp = sub.add_parser("export", help="write a PNG, SVG or draw.io file")
@@ -665,7 +687,7 @@ def build_parser() -> argparse.ArgumentParser:
     sp.add_argument(
         "--read-only",
         action="store_true",
-        help="live view only: no editor, nothing saved; safe to share through a tunnel",
+        help="live view only: no editor, nothing saved; viewers can't change anything",
     )
     sp.add_argument(
         "--embed",

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/share.py

@@ -4,6 +4,10 @@ Uses the GitHub CLI (``gh api``), so it inherits the user's login. Gists are sec
 ``public``. The gist made for each input/selection is remembered in the user's cache directory, so
 sharing again updates the same gist and the link stays the same. The VS Code extension does the same
 without gh (vscode/src/gist.ts) and shares the cache: keep the two in step.
+
+Off unless ``QDBD_ALLOW_SHARE`` is set: a gist puts the schema outside the organisation's control, which a
+client's data agreements may not allow. The extension's own switch is the ``quickdbd.allowSharing`` setting.
+Even then, every share shows ``DISCLAIMER`` and asks first; the extension's dialog (export.ts) says the same.
 """
 
 from __future__ import annotations
@@ -15,11 +19,23 @@ import subprocess
 from dataclasses import dataclass
 from pathlib import Path
 
+ALLOW_ENV = "QDBD_ALLOW_SHARE"
+DISCLAIMER = """\
+Before you share: this uploads the diagram (every table and column name, type, key, relationship
+and comment) to a GitHub gist. Anyone with the link can open it, and copies can outlive the gist.
+By sharing, you confirm that you have the right to publish this schema, that your organisation's
+policies and any client agreements allow it, and that qdbd's authors are not liable for any
+disclosure. Full disclaimer: https://qdbd.dev/sharing/#disclaimer"""
+
 
 class ShareError(Exception):
     pass
 
 
+def allowed() -> bool:
+    return os.environ.get(ALLOW_ENV, "").strip().lower() in ("1", "true", "yes", "on")
+
+
 @dataclass
 class Shared:
     link: str  # gistpreview: renders the gist's HTML, keeps the #view part of the URL

{quickdbd_cli-0.3.4.dist-info → quickdbd_cli-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: quickdbd-cli
-Version: 0.3.4
+Version: 0.4.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/
@@ -65,10 +65,10 @@ Description-Content-Type: text/markdown
 </p>
 
 <p align="center">
-  <a href="https://qdbd.dev/demo/adventureworks/#t=SalesOrderHeader"><img src="https://raw.githubusercontent.com/MarkPhamm/quickdbd-cli/main/docs/assets/img/hero.png" alt="The AdventureWorks sample database as a qdbd diagram, with the SalesOrderHeader table selected" width="760"></a>
+  <a href="https://qdbd.dev/demo/adventureworks-dw/#t=FactInternetSales"><img src="https://raw.githubusercontent.com/MarkPhamm/quickdbd-cli/main/docs/assets/img/hero.png" alt="The AdventureWorks DW star schema as a qdbd diagram, with the FactInternetSales table selected" width="760"></a>
 </p>
 <p align="center">
-  <em>AdventureWorks (68 tables) with its column descriptions, built by qdbd. <a href="https://qdbd.dev/demo/adventureworks/#t=SalesOrderHeader">Try it live →</a></em>
+  <em>AdventureWorks DW (28 tables), a star schema in five regions, built by qdbd. <a href="https://qdbd.dev/demo/adventureworks-dw/#t=FactInternetSales">Try it live →</a></em>
 </p>
 
 ## What is qdbd?
@@ -169,7 +169,7 @@ In VS Code (or Cursor), the [extension](https://qdbd.dev/vscode/) does the same
 ```sh
 qdbd build schema.txt -o schema.html      # one self-contained page
 qdbd export schema.txt -o schema.png      # or .svg, .drawio
-qdbd share schema.txt                     # a link to the page, via a GitHub gist
+QDBD_ALLOW_SHARE=1 qdbd share schema.txt  # a link via a GitHub gist: off by default, see the disclaimer
 ```
 
 ## Run in CI
@@ -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.4.0
         with:
           path: erd/                  # schema file(s) or folder(s)
           output: site/index.html
@@ -257,7 +257,7 @@ No. qdbd only borrows the text syntax.
 No. It reads `.txt` / `.dbml` schema files or a dbt `manifest.json`. Nothing connects to a warehouse.
 
 **Does my schema leave my machine?**
-Only if you run `qdbd share`, which uploads the page to a GitHub gist in your account (secret by default), or connect an AI agent through `qdbd mcp`, whose answers go to your AI provider. `qdbd serve` loads its code editor from a CDN; the built pages load nothing.
+Only if you turn sharing on (`QDBD_ALLOW_SHARE=1`, or `quickdbd.allowSharing` in VS Code) and run `qdbd share`, which uploads the page to a GitHub gist in your account (secret by default), publish it yourself (a tunnel, GitHub Pages), or connect an AI agent through `qdbd mcp`, whose answers go to your AI provider. `qdbd serve` loads its code editor from a CDN; the built pages load nothing.
 
 **How big can a diagram get?**
 The demos go up to 200 tables. Search, selectors, regions and collapsed views keep large diagrams workable; `--select` builds a page with just the part you need.

{quickdbd_cli-0.3.4.dist-info → quickdbd_cli-0.4.0.dist-info}/RECORD

@@ -1,13 +1,13 @@
-quickdbd_cli/__init__.py,sha256=oYLGMpySamd16KLiaBTfRyrAS7_oyp-TOEHmzmeumwg,22
+quickdbd_cli/__init__.py,sha256=42STGor_9nKYXumfeV5tiyD_M8VdcddX7CEexmibPBk,22
 quickdbd_cli/__main__.py,sha256=E6Gls0DNz8GQK2K-kOUIx8cYhgANW_CH54VKrfCfs14,52
 quickdbd_cli/agent.py,sha256=LEuReTkwWDlRLs-GfQQMpMosHDFWbin0EAXRo73j-dA,37202
-quickdbd_cli/cli.py,sha256=h9pTnGnprYOhyuEpjdd32QyAqR-skJRTBvoipIyCZS0,29522
+quickdbd_cli/cli.py,sha256=kphlsJHzp-agb01rlw4PD2_SnriOtr-yRZPuW3I5B_E,30634
 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=pn4Jlcce5nniH7NtGoZjzrTH_dTw4qIhio4bWXGupVw,8031
+quickdbd_cli/html.py,sha256=eZSECAaP-vxC_qGXOy0T7cXT7WkJeL7RixYvzMCDCZQ,8309
 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
@@ -16,7 +16,7 @@ quickdbd_cli/model.py,sha256=lQcj89gDg2y4v_xhJX0_PWoWKGx0rg2emREVL_LA6uQ,3352
 quickdbd_cli/parser.py,sha256=MpWvYWNMIfl8PNKGDyVqVA_RUsuD21oZQqTT7yZd89g,33018
 quickdbd_cli/project.py,sha256=Iu6aXJNxCbM9KDRbLaxTb7SfbVDv7PkajzKZX4-XfDk,4570
 quickdbd_cli/serve.py,sha256=NqYAcfT4lySRckAG2tkrZwmRbzYDjdNh18Yh4Er_hPo,12271
-quickdbd_cli/share.py,sha256=42VOsau_Ek3rDriakuAxt8pDenimEMrfbGgSNe74GV8,3840
+quickdbd_cli/share.py,sha256=njzF4HpQ-ymusLzzNb_ndvqWGlDaljx7TFP-mZj4lPU,4782
 quickdbd_cli/tags.py,sha256=fOMcz3N8YAIqh5uJJ3GuYMBCkfOViGRCVNb3Ufz63GM,4098
 quickdbd_cli/targets.py,sha256=zvge0c2_XOC13gnv2C_XMf_ZmDcpOFPzld2PoyOtyxU,8740
 quickdbd_cli/assets/Inter-Bold.ttf,sha256=KIMWCZseCkekcW0VkJgAXu98AGaSHzTjIAOT29sBlH8,420428
@@ -28,15 +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/render.js,sha256=WzxX_sUgdz0O4GgiaupKl8J_LI4YCqF9PUxzRbwebwo,31891
 quickdbd_cli/assets/style.css,sha256=ttyGKLti1sU-NMp9CBTDgaznfeU14XjWquFJr9XGsaA,18877
 quickdbd_cli/assets/syntax-reference.md,sha256=WERcsWjyrfeHQPgxQriWKBsqFJnmWTQ2oRZjKYAHhKc,5322
 quickdbd_cli/assets/viewer.js,sha256=3rKXI80TNv9jF1dJNQa3Gpy0042yTcGfTz_8qg4h5WU,49676
-quickdbd_cli-0.3.4.dist-info/METADATA,sha256=ubcoaxo_WRsI_-5TAdjNoR1G9kWcfsRTT_ibmIXdAzA,17195
-quickdbd_cli-0.3.4.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
-quickdbd_cli-0.3.4.dist-info/entry_points.txt,sha256=nRhiYYug-XOY95nWUmi4oanico3Zjkfqk2OHtIE6SQ0,47
-quickdbd_cli-0.3.4.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-quickdbd_cli-0.3.4.dist-info/licenses/NOTICE,sha256=pyv3BfIYiGzKLU4w-GcBe7GXoXxHqZ97Mf6Zpx_3_i0,2067
-quickdbd_cli-0.3.4.dist-info/licenses/src/quickdbd_cli/assets/Inter-LICENSE.txt,sha256=JiSB6ERSGzJvXs0FPlm5jIstp4yO4b27boF0MF5Uk1o,4380
-quickdbd_cli-0.3.4.dist-info/licenses/src/quickdbd_cli/assets/elk-LICENSE.md,sha256=Y36B9KG2tAeVNcSZ_KBeI4z3YFwf9bdtYNfafOlnAMk,14443
-quickdbd_cli-0.3.4.dist-info/RECORD,,
+quickdbd_cli-0.4.0.dist-info/METADATA,sha256=o9bIn-TRuVLhAhKC22kQPosVOYP7tI7Ts5XxF02LqCQ,17359
+quickdbd_cli-0.4.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+quickdbd_cli-0.4.0.dist-info/entry_points.txt,sha256=nRhiYYug-XOY95nWUmi4oanico3Zjkfqk2OHtIE6SQ0,47
+quickdbd_cli-0.4.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+quickdbd_cli-0.4.0.dist-info/licenses/NOTICE,sha256=pyv3BfIYiGzKLU4w-GcBe7GXoXxHqZ97Mf6Zpx_3_i0,2067
+quickdbd_cli-0.4.0.dist-info/licenses/src/quickdbd_cli/assets/Inter-LICENSE.txt,sha256=JiSB6ERSGzJvXs0FPlm5jIstp4yO4b27boF0MF5Uk1o,4380
+quickdbd_cli-0.4.0.dist-info/licenses/src/quickdbd_cli/assets/elk-LICENSE.md,sha256=Y36B9KG2tAeVNcSZ_KBeI4z3YFwf9bdtYNfafOlnAMk,14443
+quickdbd_cli-0.4.0.dist-info/RECORD,,