Metadata-Version: 2.1
Name: observable_jupyter
Version: 0.1.11
Summary: Embed Observable cells hosted on observablehq.com into Jupyter notebooks.
Home-page: https://github.com/observablehq/observable_jupyter
Author: Thomas Ballinger
Author-email: me@ballingt.com
License: ISC license
Keywords: observable_jupyter
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: dev
License-File: LICENSE

# observable_jupyter

<p align="center">
<a href="https://pypi.python.org/pypi/observable_jupyter">
    <img src="https://img.shields.io/pypi/v/observable_jupyter.svg" />
</a>
<a href="https://github.com/thomasballinger/observable-jupyter">
    <img src="https://img.shields.io/github/checks-status/thomasballinger/observable-jupyter/main"/>
</a>
</p>

Embed cells from [Observable](https://observablehq.com/) notebooks into Jupyter notebooks.

[View demo notebook on Colab](https://colab.research.google.com/drive/1t_wcE-NqoPO-dpnrB9VMQ0KUxR5e1rML?usp=sharing)

To install the library, import the embed function, and embed the "graphic" cell from [this Observable notebook](https://observablehq.com/@mbostock/epicyclic-gearing):
~~~py
!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:
~~~py
embed('@d3/gallery')
~~~

You may want to swap in your own data into a D3 chart:
~~~py
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!
~~~py
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.

At the time of writing, this behavior is different than the Observable embed default.

## About this library

This is an unofficial library for embedding Observable notebooks 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](./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](./js/package.json).

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



