Skip to main content

Jupyter extension to serve bokeh resources (js and css files).

Project description

bokeh-resources

Bokeh (https://bokeh.org/) Python plotting library has two main modes for serving static content: CDN and inline.

  • 'cdn' (=content distribution network) mode needs internet connection every time you open the notebook

  • 'inline' mode increases the size of ipynb files by 6Mb

bokeh-resources is a jupyter extension that makes jupyter serve bokeh files locally.

It keeps the size of ipynb files small and works offline as well.

Installation:

Install the nbextensions if you haven't already:

pip install jupyter_contrib_nbextensions && jupyter contrib nbextensions install

Then either

pip install bokeh-resources
python -m bokeh_resources.install

Or

git clone https://github.com/axil/bokeh-resources
cd bokeh_resources/bokeh_resources
python install.py

This will install the extension to jupyter and to create the symlink (see 'Updating' below)

After this the package itself can be safely uninstalled (pip uninstall bokeh-resources).

To uninstall the extension run

jupyter nbextensions uninstall bokeh_resources

Usage:

In bokehlab:

%bokehlab local

In bokeh:

from bokeh.io import output_notebook
from bokeh.resources import Resources
output_notebook(Resources('server', root_url='/nbextensions/bokeh_resources'))

Updating:

Serving is performed through a symbolic link (or a directory junction on Windows).

This means that it is resilient to bokeh updates.

(= the extension does not need to be updated when bokeh is updated to the next version).

The extension needs to be updated when switching to a different python version. Use argument -f/--force to force overwriting of the symlink to the uptodate bokeh resources directory witin the current python version:

python -m bokeh_resources.install -f

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

bokeh-resources-0.4.tar.gz (2.9 kB view hashes)

Uploaded Source

Built Distribution

bokeh_resources-0.4-py3-none-any.whl (3.1 kB view hashes)

Uploaded Python 3

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