energydb-inspect
A local visual inspector for energydb: a read-only dashboard over your Postgres + ClickHouse showing the asset tree, timeseries plots, a map of the assets, and the raw rows plus the SQL "under the hood".
Inspect your energydb
Point it at any energydb. It is strictly read-only by default, so it is safe against production:
uvx energydb-inspect --pg-dsn postgresql://… --ch-url http://…
# or: pip install energydb-inspect && energydb-inspect --pg-dsn … --ch-url …
The dashboard opens at http://localhost:8000.
You can also pass the connection via the environment or a .env in the working directory. Prefer
this for real credentials, so they don't show up in ps/shell history:
# .env
TIMEDB_PG_DSN=postgresql://…
TIMEDB_CH_URL=http://…
uvx energydb-inspect
Try it on a throwaway database
Spin up energydb's local-db (in the energydb repo,
under local-db/):
docker compose up -d # Postgres :5433 + ClickHouse :8123
Point the inspector at it. INSPECT_WRITABLE=1 enables the Reset button against the throwaway DB:
# .env
TIMEDB_PG_DSN=postgresql://postgres:devpassword@localhost:5433/devdb
TIMEDB_CH_URL=http://default:devpassword@localhost:8123/default
INSPECT_WRITABLE=1
uvx energydb-inspect # dashboard at http://localhost:8000 (empty until you add data)
To fill it with a demo portfolio, run the example notebook below and watch the dashboard update live.
INSPECT_WRITABLE only works against a local database; to enable it against a remote host, also set
INSPECT_TRUSTED_DB=1.
The example notebook
The repo ships a guided marimo notebook,
energydb_inspect/notebooks/demo.py, that builds the demo portfolio step by step. It is run
separately with marimo (from a checkout):
uv run --extra notebook python -m marimo edit energydb_inspect/notebooks/demo.py
It opens at http://localhost:2718. Run the cells top to bottom against a writable database (the local-db above) and watch the tree, map and plots fill in live in the dashboard.
Develop from source
git clone https://github.com/rebase-energy/energydb-inspect && cd energydb-inspect
uv sync
Run the backend (read-only API; also serves the built dashboard if web/dist has been bundled into
energydb_inspect/_static) and the Vite dev server (hot reload) in two terminals:
INSPECT_WRITABLE=1 uv run python -m uvicorn energydb_inspect.app:app --reload --port 8000
cd web && npm install && npm run dev # http://localhost:5173
On NixOS, bun/node may not be on PATH; use nix shell nixpkgs#bun -c bun run dev.
Web demo (in-browser, no database)
A zero-backend build of the dashboard exists for hosting a public "what is energydb" demo. See docs/HOSTING.md.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file energydb_inspect-0.9.0.tar.gz.
File metadata
- Download URL: energydb_inspect-0.9.0.tar.gz
- Upload date:
- Size: 32.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bb5521bb55fc7629bda4caf7d153f04f931882eb8fbfdd36e429803a8ee6ff42
|
|
| MD5 |
14538505aeed5cef0daf994ddb880594
|
|
| BLAKE2b-256 |
75a9d096df4a5ea637a5c57b6d587888cd551fa7c074342688ce443794244d56
|
Provenance
The following attestation bundles were made for energydb_inspect-0.9.0.tar.gz:
Publisher:
publish.yml on rebase-energy/energydb-inspect
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
energydb_inspect-0.9.0.tar.gz -
Subject digest:
bb5521bb55fc7629bda4caf7d153f04f931882eb8fbfdd36e429803a8ee6ff42 - Sigstore transparency entry: 2302785726
- Sigstore integration time:
-
Permalink:
rebase-energy/energydb-inspect@5bcd4ffa34f3bebdf0f5775c1a0f47c7c2302a89 -
Branch / Tag:
refs/tags/v0.9.0 - Owner: https://github.com/rebase-energy
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@5bcd4ffa34f3bebdf0f5775c1a0f47c7c2302a89 -
Trigger Event:
release
-
Statement type:
File details
Details for the file energydb_inspect-0.9.0-py3-none-any.whl.
File metadata
- Download URL: energydb_inspect-0.9.0-py3-none-any.whl
- Upload date:
- Size: 509.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
eac847172d660ca62838bbf00d26db2b7a6e55b3e15a4179edc826df71731be4
|
|
| MD5 |
db29398c72e7b32bdb9526f8e6bf3773
|
|
| BLAKE2b-256 |
a640c4d83dd4117286ba9a76caf31dd70d8b9ec85df006d84dee3917240bf62a
|
Provenance
The following attestation bundles were made for energydb_inspect-0.9.0-py3-none-any.whl:
Publisher:
publish.yml on rebase-energy/energydb-inspect
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
energydb_inspect-0.9.0-py3-none-any.whl -
Subject digest:
eac847172d660ca62838bbf00d26db2b7a6e55b3e15a4179edc826df71731be4 - Sigstore transparency entry: 2302785775
- Sigstore integration time:
-
Permalink:
rebase-energy/energydb-inspect@5bcd4ffa34f3bebdf0f5775c1a0f47c7c2302a89 -
Branch / Tag:
refs/tags/v0.9.0 - Owner: https://github.com/rebase-energy
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@5bcd4ffa34f3bebdf0f5775c1a0f47c7c2302a89 -
Trigger Event:
release
-
Statement type:
