Merge pull request #1 from hotdata-dev/feat/workspace-health

Feat/workspace health

Author: eddietejeda

README.md

@@ -1,16 +1,19 @@
-# hotdata-core-notebook
+# hotdata-runtime
 
-Shared **Hotdata** client and domain types for notebook UIs (Marimo, Jupyter, etc.). UI frameworks depend on this package; they do not belong here.
+Shared runtime primitives for Hotdata integrations: workspace/session semantics, execution context, query state, run history, and replayable result handles. Framework packages (Marimo, Jupyter, Streamlit, LangGraph) depend on this package.
 
 Install:
 
 ```bash
-pip install hotdata-core-notebook
+uv pip install hotdata-runtime
+# or: pip install hotdata-runtime
 ```
 
-Development:
+Development (uses **uv**; creates `.venv/` in this repo):
 
 ```bash
-pip install -e ".[dev]"
-pytest
+uv sync --locked
+uv run pytest
 ```
+
+`uv.lock` is checked in so CI can run `uv sync --locked`. The default **dev** group (pytest) is enabled via `[tool.uv] default-groups`.

hotdata_core_notebook/__init__.py

@@ -0,0 +1,36 @@
+"""Hotdata runtime primitives for notebook and app integrations."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+from hotdata_runtime.client import HotdataClient, from_env
+from hotdata_runtime.env import (
+    default_api_key,
+    default_host,
+    default_session_id,
+    explicit_workspace_id,
+    list_workspaces,
+    normalize_host,
+    pick_workspace,
+)
+from hotdata_runtime.health import workspace_health_lines
+from hotdata_runtime.result import QueryResult
+
+try:
+    __version__ = version("hotdata-runtime")
+except PackageNotFoundError:
+    __version__ = "0.0.0+unknown"
+
+__all__ = [
+    "__version__",
+    "HotdataClient",
+    "QueryResult",
+    "workspace_health_lines",
+    "default_api_key",
+    "default_host",
+    "default_session_id",
+    "explicit_workspace_id",
+    "from_env",
+    "list_workspaces",
+    "normalize_host",
+    "pick_workspace",
+]

hotdata_runtime/__init__.py

@@ -15,14 +15,14 @@
 from hotdata.models.query_response import QueryResponse
 from hotdata.models.table_info import TableInfo
 
-from hotdata_core_notebook.env import (
+from hotdata_runtime.env import (
     default_api_key,
     default_host,
     default_session_id,
     normalize_host,
     pick_workspace,
 )
-from hotdata_core_notebook.result import QueryResult
+from hotdata_runtime.result import QueryResult
 
 _TERMINAL = frozenset({"succeeded", "failed", "cancelled"})
 

hotdata_core_notebook/client.py hotdata_runtime/client.pyhotdata_core_notebook/client.py renamed to hotdata_runtime/client.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+
+from hotdata.exceptions import ApiException
+
+from hotdata_runtime.client import HotdataClient
+
+
+def workspace_health_lines(client: HotdataClient) -> tuple[bool, list[str]]:
+    """Return ``(ok, parts)`` where ``parts`` are short markdown fragments.
+
+    On failure, ``ok`` is False and ``parts`` is a single-element list with the error text.
+    """
+    try:
+        listing = client.connections().list_connections()
+        n = len(listing.connections)
+        lines = [
+            "**API** reachable",
+            f"**workspace** `{client.workspace_id}`",
+            f"**connections** {n}",
+        ]
+        if client.session_id:
+            lines.append(f"**sandbox** `{client.session_id}`")
+        return True, lines
+    except ApiException as e:
+        return False, [e.reason or str(e)]
+    except Exception as e:
+        return False, [str(e)]

hotdata_core_notebook/env.py hotdata_runtime/env.pyhotdata_core_notebook/env.py renamed to hotdata_runtime/env.py

@@ -3,9 +3,9 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
-name = "hotdata-core-notebook"
+name = "hotdata-runtime"
 version = "0.1.0"
-description = "Hotdata API client and shared models for notebook integrations"
+description = "Workspace/session runtime primitives for Hotdata integrations"
 readme = "README.md"
 requires-python = ">=3.10"
 license = { text = "MIT" }
@@ -14,13 +14,17 @@ dependencies = [
   "pandas>=2.0",
 ]
 
-[project.optional-dependencies]
+[dependency-groups]
 dev = [
+  "packaging>=23",
   "pytest>=8.0",
 ]
 
+[tool.uv]
+default-groups = ["dev"]
+
 [tool.hatch.build.targets.wheel]
-packages = ["hotdata_core_notebook"]
+packages = ["hotdata_runtime"]
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]

hotdata_runtime/health.py

@@ -6,8 +6,8 @@
 
 import pytest
 
-from hotdata_core_notebook.env import normalize_host, pick_workspace
-from hotdata_core_notebook.client import HotdataClient
+from hotdata_runtime.env import normalize_host, pick_workspace
+from hotdata_runtime.client import HotdataClient
 
 
 @pytest.mark.parametrize(
@@ -47,7 +47,7 @@ def test_pick_workspace_chooses_first_active(monkeypatch: pytest.MonkeyPatch):
     ]
     listing = SimpleNamespace(workspaces=items)
 
-    with patch("hotdata_core_notebook.env.WorkspacesApi") as Api:
+    with patch("hotdata_runtime.env.WorkspacesApi") as Api:
         Api.return_value.list_workspaces.return_value = listing
         assert pick_workspace("k", "https://api.hotdata.dev", None) == "ws_2"
 
@@ -62,7 +62,7 @@ def test_pick_workspace_falls_back_to_first(monkeypatch: pytest.MonkeyPatch):
     ]
     listing = SimpleNamespace(workspaces=items)
 
-    with patch("hotdata_core_notebook.env.WorkspacesApi") as Api:
+    with patch("hotdata_runtime.env.WorkspacesApi") as Api:
         Api.return_value.list_workspaces.return_value = listing
         assert pick_workspace("k", "https://api.hotdata.dev", None) == "ws_1"
 

hotdata_core_notebook/result.py hotdata_runtime/result.pyhotdata_core_notebook/result.py renamed to hotdata_runtime/result.py

@@ -0,0 +1,64 @@
+from __future__ import annotations
+
+from unittest.mock import patch
+
+from hotdata.exceptions import ApiException
+
+from hotdata_runtime.client import HotdataClient
+from hotdata_runtime.health import workspace_health_lines
+
+
+def test_workspace_health_ok():
+    client = HotdataClient("k", "ws", host="https://api.hotdata.dev")
+    listing = type("L", (), {"connections": [object()]})()
+
+    class FakeConnectionsApi:
+        def list_connections(self):
+            return listing
+
+    with patch.object(client, "connections", return_value=FakeConnectionsApi()):
+        ok, parts = workspace_health_lines(client)
+    assert ok is True
+    assert any("reachable" in p for p in parts)
+
+
+def test_workspace_health_ok_includes_sandbox_when_session_set():
+    client = HotdataClient(
+        "k", "ws", host="https://api.hotdata.dev", session_id="sb_test"
+    )
+    listing = type("L", (), {"connections": [object()]})()
+
+    class FakeConnectionsApi:
+        def list_connections(self):
+            return listing
+
+    with patch.object(client, "connections", return_value=FakeConnectionsApi()):
+        ok, parts = workspace_health_lines(client)
+    assert ok is True
+    assert any("sandbox" in p and "sb_test" in p for p in parts)
+
+
+def test_workspace_health_api_error():
+    client = HotdataClient("k", "ws", host="https://api.hotdata.dev")
+
+    class Boom:
+        def list_connections(self):
+            raise ApiException(status=500, reason="nope")
+
+    with patch.object(client, "connections", return_value=Boom()):
+        ok, parts = workspace_health_lines(client)
+    assert ok is False
+    assert parts == ["nope"]
+
+
+def test_workspace_health_non_api_error():
+    client = HotdataClient("k", "ws", host="https://api.hotdata.dev")
+
+    class Boom:
+        def list_connections(self):
+            raise OSError("connection refused")
+
+    with patch.object(client, "connections", return_value=Boom()):
+        ok, parts = workspace_health_lines(client)
+    assert ok is False
+    assert parts == ["connection refused"]