Examples

Runnable programs, from a first query to a live dashboard over Postgres.

The examples/ directory in the repository holds runnable programs, each focused on one thing. They run against a local build of the repository, so they exercise your changes rather than the released package — see the README there for the two commands that set that up.

ExampleShows
python_source.pyPushing changes into a Python source and printing the diffs
streaming.pyConsuming results as an async iterator
sync_quickstart.pyThe same thing with the blocking API
install_plugin.pyInstalling a plugin from ghcr.io and using it
postgres_cdc.pyFollowing a real Postgres table through change data capture

Only the last two need network access, and postgres_cdc.py needs Docker.

Longer walkthroughs


Postgres dashboard

Follow a Postgres table into a live dashboard, using only published plugins.