Repository files navigation

A Jupyter extension for renderingBokeh content within Jupyter. See also the separateipywidgets_bokeh library for support for using Jupyter widgets/ipywidgets objects within Bokeh applications.

For versions 3.0 and newer of JupyterLab, you have the option to installjupyter_bokeh with eitherpip orconda:

pip install jupyter_bokeh

or

conda install -c conda-forge jupyter_bokeh

For versions of Jupyter Lab older than 3.0, you must install the labextensionseparately:

conda install -c conda-forge jupyter_bokehjupyter labextension install @jupyter-widgets/jupyterlab-managerjupyter labextension install @bokeh/jupyter_bokeh

To install a specific version:

jupyter labextension install @bokeh/jupyter_bokeh@x.y.x

The coreBokeh library is generally version independent ofJupyterLab and thisjupyter_bokeh extensionfor versions ofbokeh>=2.0.0.

Our goal is thatjupyter_bokeh minor releases (using theSemVer pattern) aremade to follow JupyterLab minor release bumps, while micro releases are for newjupyter_bokeh featuresor bug fix releases. We've been previously inconsistent with having the extension release minor version bumpstrack that of JupyterLab, so users seeking to find extension releases that are compatible with their JupyterLabinstallation may refer to the below table.

Note: You will need NodeJS to build the extension package.

Thejlpm command is JupyterLab's pinned version ofyarn that is installed with JupyterLab. You may useyarn ornpm in lieu ofjlpm below.

# Clone the repo to your local environment# Change directory to the jupyter_bokeh directory# Install package in development modepip install -e.# Link your development version of the extension with JupyterLabjupyter labextension develop. --overwrite# Rebuild extension Typescript source after making changesjlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when neededjlpm run watch# Run JupyterLab in another terminaljupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, thejlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

pip uninstall jupyter_bokeh