Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,16 @@ htmlcov/
.DS_Store
.idea/
.vscode/
.wrangler/

# Local example DBs
examples/*.db
examples/.ipynb_checkpoints/
examples/juv.tmp*.py

# Local parquet files (large demo data)
/le_places.parquet
/categories.parquet

# Package installers
*.pkg
Expand All @@ -38,3 +45,5 @@ sidemantic_definitions.sql
node_modules/
bun.lockb
package.json
!js/package.json
!js/bun.lock
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,32 @@ Install:
uv add sidemantic
```

Malloy support (uv):
```bash
uv add "sidemantic[malloy]"
```

Notebook widget (uv):
```bash
uv add "sidemantic[widget]" jupyterlab
uv run jupyter lab
```

Marimo (uv):
```bash
uv add "sidemantic[widget]" marimo
uv run marimo edit
```

```python
import duckdb
from sidemantic.widget import MetricsExplorer

conn = duckdb.connect(":memory:")
conn.execute("create table t as select 1 as value, 'a' as category, date '2024-01-01' as d")
MetricsExplorer(conn.table("t"), time_dimension="d")
```

Define models in SQL, YAML, or Python:

<details>
Expand Down
408 changes: 408 additions & 0 deletions examples/widget_demo.ipynb

Large diffs are not rendered by default.

117 changes: 117 additions & 0 deletions js/bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 15 additions & 0 deletions js/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"name": "sidemantic-widget-js",
"private": true,
"type": "module",
"scripts": {
"build": "esbuild widget.js --bundle --format=esm --outfile=../sidemantic/widget/static/widget.js --minify",
"watch": "esbuild widget.js --bundle --format=esm --outfile=../sidemantic/widget/static/widget.js --watch"
},
"devDependencies": {
"esbuild": "^0.20.0"
},
"dependencies": {
"apache-arrow": "^17.0.0"
}
}
Loading