A Jupyter extension for rendering Bokeh content.
- Jupyter Lab or Notebook
To install the latest version in Jupyter Lab:
conda install -c bokeh jupyter_bokeh jupyter labextension install @jupyter-widgets/jupyterlab-manager jupyter labextension install @bokeh/jupyter_bokeh
To install a specific version:
jupyter labextension install @firstname.lastname@example.org
On slow or limited memory systems, one can use
--minimize=False to reduce compilation
times or make Jupyter Lab build runtime bundles at all.
jupyter_bokeh is automatically installed in Jupyter Notebook. In case of a non-standard setup, one can install the extensions with:
jupyter nbextension install --sys-prefix --symlink --py jupyter_bokeh jupyter nbextension enable jupyter_bokeh --py --sys-prefix
Our goal is that
jupyter_bokeh minor releases (using the SemVer pattern) are
made to follow JupyterLab minor release bumps and micro releases are for new
or bug fix releases. We've been previously inconsistent with having the extension release minor version bumps
track that of JupyterLab, so users seeking to find extension releases that are compatible with their JupyterLab
installation may refer to the below table.
Compatible JupyterLab and jupyter_bokeh versions
For a development install (requires npm version 6 or later), do the following in the repository directory:
npm install jupyter labextension link .
To rebuild the package and the JupyterLab app:
npm run build jupyter lab build
To incrementally rebuild the extension and JupyterLab after changes you can run
npm run watch
and in another terminal run
jupyter lab --watch
When making a new release for compatibility with a new JupyterLab minor release series, please make a minor release bump in this extension (i.e. 0.6.3 -> 0.7.0). Conversely, when creating a release for a new feature or bug fix, please make a micro release bump (i.e. 0.6.3 -> 0.6.4).
There is a directory named
examples which contains a collection of notebooks that cover the various
functionalities. If you update the extension for new JupyterLab releases, please manually execute each and check that the
expected behavior occurs. If you extend the
jupyter_bokeh, please add a new notebook that covers the new functionality.