Skip to main content

Observable JavaScript notebooks as reusable Python widgets

Project description

pyobservablejs

CI PyPI Python versions License

pyobservablejs embeds reactive Observable notebooks in Python. Author cells or load an existing notebook, render all or selected cells, synchronize Python values, read structured browser results, and inspect the dependency graph.

An authored notebook with an interactive filter and plot

It works in JupyterLab, marimo, VS Code notebooks, Google Colab, and other environments that support anywidget.

Install or try

Add pyobservablejs to an existing Python 3.11 or newer environment:

uv pip install pyobservablejs

Or open a disposable marimo environment with the package available:

uvx --with pyobservablejs marimo edit notebook.py

This command installs marimo and pyobservablejs in the temporary environment.

Quickstart

Paste this into the marimo editor opened above:

import marimo as mo
import observablejs as obs

control = obs.ojs(
    """
    viewof threshold = Inputs.range([0, 1], {
      value: 0.5,
      step: 0.1,
      label: "Threshold"
    })
    """,
    key="threshold",
)

result = obs.js(
    'html`<strong>Threshold: ${threshold}</strong>`',
    key="result",
)

notebook = obs.Notebook(
    control,
    result,
    variables={"threshold": 0.5},
)

mo.ui.anywidget(notebook.view())

Each cell key is its portable Python identity. Render one result with notebook.view("result").

Capabilities

Task API
Author JavaScript, Observable JavaScript, Markdown, and HTML cells obs.js, obs.ojs, obs.md, obs.html
Load Notebook Kit HTML or an ObservableHQ notebook Notebook.from_html, Notebook.from_observablehq
Render a whole notebook or selected keyed cells notebook.view() and notebook.view("chart")
Update Python-owned variables notebook.update_variables({"threshold": 0.8})
Read pending, successful, and failed browser results view.state and view.state.result("chart")
Inspect dependencies or export a diagram view.state.graph, to_mermaid(), and to_d2()

Views from one Notebook share controller variables and supported browser inputs. Each view keeps its own result state plus input and settled revision metadata.

Python and browser values updating one notebook

Import notebooks

Notebook cells execute as JavaScript in the host page. Treat imported Notebook Kit HTML, ObservableHQ notebooks, and remote modules as trusted code. See Browser execution.

import marimo as mo
import observablejs as obs

notebook = obs.Notebook.from_observablehq("@d3/world-tour")
mo.ui.anywidget(notebook.view())

An imported ObservableHQ notebook

Documentation

Read the documentation for the quickstart, task guides, recipes, troubleshooting, and API reference.

Acknowledgements

Thanks to the Observable team for Notebook Kit, which provides the notebook format and runtime. pyobsplot informed the Python variable API. Trevor Manz's anywidget composition demo shaped the shared-session design.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyobservablejs-0.0.3.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyobservablejs-0.0.3-py3-none-any.whl (1.5 MB view details)

Uploaded Python 3

File details

Details for the file pyobservablejs-0.0.3.tar.gz.

File metadata

  • Download URL: pyobservablejs-0.0.3.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for pyobservablejs-0.0.3.tar.gz
Algorithm Hash digest
SHA256 be604768cf9da3c813d7835bc0b3dfc23bb23feb43dbfb94e2a20b69e7a9cd72
MD5 fb2580a2007c094ce3fb8a5df217d53b
BLAKE2b-256 ab60840dabe31aa92e1f0dcd36897c4f4850e8f1f8d4f649a03489b2cef3ca7c

See more details on using hashes here.

File details

Details for the file pyobservablejs-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: pyobservablejs-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for pyobservablejs-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 86293ea3ce96f35f03570f6b75d969bf49430518af78af2ac4a1159df69f4ed4
MD5 2468752093c093658257173d71c37bc3
BLAKE2b-256 2840a137748e47812db965f47fddab01adc795d019aa1b142b1c6116a2921d8e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page