datacharter 0.3.3__tar.gz → 0.3.4__tar.gz

{datacharter-0.3.3 → datacharter-0.3.4}/.github/workflows/test.yml

@@ -71,6 +71,8 @@ jobs:
         run: cd ui && npm ci
       - name: Typecheck + build
         run: cd ui && npm run build
+      - name: Unit test UI
+        run: cd ui && npm test
 
   package:
     runs-on: ubuntu-latest

{datacharter-0.3.3 → datacharter-0.3.4}/CHANGELOG.md

@@ -5,6 +5,15 @@ Format: [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ## [Unreleased]
 
+## [0.3.4] - 2026-07-24
+
+### Added
+
+- Empty workspaces get an "add your data" first-run launchpad (add a source / drop a
+  CSV / load the demo dataset) instead of the demo feature-tour, which now auto-shows
+  only when the workspace has sources. New `POST /api/demo` loads the demo `store` as a
+  normal, deletable source.
+
 ## [0.3.3] - 2026-07-24
 
 ### Fixed

{datacharter-0.3.3 → datacharter-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datacharter
-Version: 0.3.3
+Version: 0.3.4
 Summary: Charter your data — contract-governed local data exploration, powered by DuckDB
 Project-URL: Homepage, https://github.com/datacharter/datacharter
 Project-URL: Repository, https://github.com/datacharter/datacharter

{datacharter-0.3.3 → datacharter-0.3.4}/src/datacharter/__init__.py

@@ -1,3 +1,3 @@
 """DataCharter — contract-governed local data exploration."""
 
-__version__ = "0.3.3"
+__version__ = "0.3.4"

{datacharter-0.3.3 → datacharter-0.3.4}/src/datacharter/cli.py

@@ -7,6 +7,7 @@ import sys
 from pathlib import Path
 
 from datacharter import __version__
+from datacharter.demo import write_demo_data
 
 CHARTER_TEMPLATE = """\
 # DataCharter workspace — https://github.com/datacharter/datacharter
@@ -72,7 +73,7 @@ def _cmd_init(args: argparse.Namespace) -> int:
     (ws / "queries").mkdir(exist_ok=True)
     _ensure_gitignore(ws)
     if args.demo:
-        _write_demo_data(ws)
+        write_demo_data(ws)
     print(f"Workspace initialized in {ws}.")
     if args.demo:
         print("Demo data in demo/ — try: datacharter serve")
@@ -87,35 +88,6 @@ def _ensure_gitignore(ws: Path) -> None:
         gi.write_text(existing + joiner + GITIGNORE_BLOCK)
 
 
-def _write_demo_data(ws: Path) -> None:
-    import sqlite3
-
-    demo = ws / "demo"
-    demo.mkdir(exist_ok=True)
-    con = sqlite3.connect(str(demo / "store.db"))
-    try:
-        con.execute("CREATE TABLE customers (id INTEGER, email TEXT, tier TEXT)")
-        con.executemany(
-            "INSERT INTO customers VALUES (?, ?, ?)",
-            [
-                (1, "ada@example.com", "pro"),
-                (2, "grace@example.com", "free"),
-                (3, "edsger@example.com", "pro"),
-            ],
-        )
-        con.execute("CREATE TABLE orders (customer_id INTEGER, total REAL, placed_on TEXT)")
-        con.executemany(
-            "INSERT INTO orders VALUES (?, ?, ?)",
-            [
-                ((i % 3) + 1, round((i * 37 % 200) + i * 0.5, 2), f"2026-01-{(i % 28) + 1:02d}")
-                for i in range(90)
-            ],
-        )
-        con.commit()
-    finally:
-        con.close()
-
-
 def _resolve_serve_workspace(directory: str) -> Path:
     """Workspace for serve; ephemeral demo when no charter.yaml (D3, no surprise writes)."""
     ws = Path(directory).resolve()
@@ -125,7 +97,7 @@ def _resolve_serve_workspace(directory: str) -> Path:
 
     demo_ws = Path(tempfile.mkdtemp(prefix="datacharter-demo-"))
     (demo_ws / "charter.yaml").write_text(DEMO_CHARTER)
-    _write_demo_data(demo_ws)
+    write_demo_data(demo_ws)
     print(f"No charter.yaml in {ws} — serving an ephemeral demo workspace ({demo_ws}).")
     print("Run `datacharter init` here to start a real workspace.")
     return demo_ws

datacharter-0.3.4/src/datacharter/demo.py

@@ -0,0 +1,43 @@
+"""The demo dataset: a small sqlite `store` (customers + orders) for onboarding."""
+
+from __future__ import annotations
+
+import sqlite3
+from pathlib import Path
+
+# Descriptor for registering the demo as a real, deletable source (see POST /api/demo).
+DEMO_SOURCE = {
+    "name": "store",
+    "type": "sqlite",
+    "path": "demo/store.db",
+    "tables": ["customers", "orders"],
+    "pii": {"customers": ["email"]},
+}
+
+
+def write_demo_data(workspace: Path) -> None:
+    """Write the demo `store.db` (customers + orders) under `<workspace>/demo/`."""
+    demo = workspace / "demo"
+    demo.mkdir(exist_ok=True)
+    con = sqlite3.connect(str(demo / "store.db"))
+    try:
+        con.execute("CREATE TABLE customers (id INTEGER, email TEXT, tier TEXT)")
+        con.executemany(
+            "INSERT INTO customers VALUES (?, ?, ?)",
+            [
+                (1, "ada@example.com", "pro"),
+                (2, "grace@example.com", "free"),
+                (3, "edsger@example.com", "pro"),
+            ],
+        )
+        con.execute("CREATE TABLE orders (customer_id INTEGER, total REAL, placed_on TEXT)")
+        con.executemany(
+            "INSERT INTO orders VALUES (?, ?, ?)",
+            [
+                ((i % 3) + 1, round((i * 37 % 200) + i * 0.5, 2), f"2026-01-{(i % 28) + 1:02d}")
+                for i in range(90)
+            ],
+        )
+        con.commit()
+    finally:
+        con.close()

{datacharter-0.3.3 → datacharter-0.3.4}/src/datacharter/server/app.py

@@ -146,8 +146,7 @@ def create_app(
         app.state.charter = load_charter(workspace)
         app.state.toolbox = ToolBox(app.state.engine, app.state.charter.sources)
 
-    @app.get("/api/sources")
-    async def sources() -> dict:
+    def _sources_payload() -> dict:
         # Credentials intentionally omitted — this payload reaches the browser.
         return {
             "warnings": app.state.charter.warnings,
@@ -165,12 +164,34 @@ def create_app(
             ],
         }
 
+    @app.get("/api/sources")
+    async def sources() -> dict:
+        return _sources_payload()
+
     @app.post("/api/sources")
     async def add_source(form: source_admin.SourceForm) -> dict:
         await asyncio.to_thread(source_admin.create_source, app.state.engine, workspace, form)
         _refresh_charter()
         return {"name": form.name}
 
+    @app.post("/api/demo")
+    async def load_demo() -> dict:
+        """Populate the workspace with the demo `store` source (idempotent)."""
+        if not any(s.name == "store" for s in app.state.charter.sources):
+            from datacharter.demo import write_demo_data
+
+            write_demo_data(workspace)
+            form = source_admin.SourceForm(
+                name="store",
+                type="sqlite",
+                path="demo/store.db",
+                tables=["customers", "orders"],
+                pii={"customers": ["email"]},
+            )
+            await asyncio.to_thread(source_admin.create_source, app.state.engine, workspace, form)
+            _refresh_charter()
+        return _sources_payload()
+
     @app.put("/api/sources/{name}")
     async def edit_source(name: str, form: source_admin.SourceForm):
         if name != form.name: