Skip to main content

Embed Observable cells hosted on observablehq.com into Jupyter notebooks.

Project description

observable-jupyter

Embed cells from Observable notebooks into Jupyter notebooks.

View demo notebook on Colab

This library provides a simple way to embed cells and pass custom inputs values to them from Python code. For more complicated data flow in Jupyter notebooks, see the related library observable-jupyter-widget which uses the Jupyter Widget system to pass data back and forth between Python and JavaScript.

Usage

To install the library, import the embed function, and embed the "graphic" cell from this Observable notebook:

!pip install observable_jupyter
from observable_jupyter import embed
embed('@mbostock/epicyclic-gearing', cells=['graphic'], inputs={'speed': 0.2})

The simplest way to use embed() is to render an entire Observable notebook:

embed('@d3/gallery')

You may want to swap in your own data into a D3 chart:

import this
text = ''.join(this.d.get(l, l) for l in this.s)
embed('@d3/word-cloud', cells=['chart'], inputs={'source': text})

With multiple cells, you can embed interactive charts!

embed(
    '@observablehq/visualize-a-data-frame-with-observable-in-jupyter,
    cells=['vegaPetalsWidget', 'viewof sepalLengthLimits', 'viewof sepalWidthLimits'],
)

Embedding specific cells with the cell keyword parameter of embed([]) causes only these cells to be shown, but every cell still runs.

This behavior is slightly different than the Observable embed default.

About this library

This library uses the APIs provided by Observable to embed notebooks hosted on Observable in Jupyter.

The library was developed at Observable but is now maintained by Thomas Ballinger. All code added before Sept 2021 is copyright Observable.

Development

See ARCHITECTURE.md for an overview.

Because Python library includes JavaScript, you'll need node as well as Python to contribute to it.

The two JavaScript files included in an installed package iframe_bundle.js and wrapper_bundle.js are not saved in this repo. They are generated by rollup, a JavaScript "bundler" that combines JavaScript source code from files in the js folder and dependencies listed in js/package.json.

Installing the Python package with or pip install -e . will automatically run the bundler and produce these files.

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

observable_jupyter-0.1.14.tar.gz (34.3 kB view details)

Uploaded Source

Built Distribution

observable_jupyter-0.1.14-py3-none-any.whl (31.3 kB view details)

Uploaded Python 3

File details

Details for the file observable_jupyter-0.1.14.tar.gz.

File metadata

  • Download URL: observable_jupyter-0.1.14.tar.gz
  • Upload date:
  • Size: 34.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.3

File hashes

Hashes for observable_jupyter-0.1.14.tar.gz
Algorithm Hash digest
SHA256 d7b358bcfd77c2c5667a8c20daa7431c9674c68fc04d9c239d2c2d00e319c225
MD5 e6f7765619444638753dde117ece4bb4
BLAKE2b-256 8cd725b4652151c89814f829647c0a4882f1b9096dc466280fb24cf2ed19300f

See more details on using hashes here.

File details

Details for the file observable_jupyter-0.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for observable_jupyter-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 b8b3090855203b312c6cffab61a67630112f539a91c0df65c7950dea6b2e842c
MD5 f9e237df70e2fbaae23fbd9b813dd0e7
BLAKE2b-256 1472cce54a7ca253e3c7f143c5c4ba5760af21b0b7a13fb86a10c2a088819699

See more details on using hashes here.

Supported by

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