Skip to content

Commit 57cb511

Browse files
committed
Document marimo example entrypoint in README.
Add an explicit examples section with a runnable command so users can quickly discover and launch the notebook integration flow.
1 parent 9cee4c7 commit 57cb511

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,16 @@ Marimo only shows **what you `return` from a cell**. Calling `mo.vstack(...)` or
4747

4848
See `examples/hotdata_basic.py` for a full notebook: five Python cells (`mo.vstack` for **controls only**, then a separate cell `return hm.query_result(editor.result)` so results show immediately — **avoid** `mo.lazy` here: it only renders after the block scrolls into view, which looks like an empty cell). If Marimo shows **empty cells**, quit and remove `examples/__marimo__/` so the UI reloads from the `.py` file only.
4949

50+
## Examples
51+
52+
- `examples/hotdata_basic.py` — end-to-end editor + browser + result rendering flow.
53+
54+
Run:
55+
56+
```bash
57+
marimo edit examples/hotdata_basic.py --no-token
58+
```
59+
5060
## Layout
5161

5262
This repo is intentionally thin: **API client, env helpers, and result models** live in **hotdata-runtime**; **hotdata-marimo** only adds Marimo widgets (`sql_editor`, `table_browser`, `display` for tables/status/history, `workspace_selector`). Import `HotdataClient` / `QueryResult` / `from_env` from **`hotdata_marimo`** or directly from **`hotdata_runtime`**.

0 commit comments

Comments
 (0)