Skip to main content

Jupyter extensions to add nbgallery integration

Project description

Project Status: Active – The project has reached a stable, usable state and is being actively developed.


This package provides several Jupyter extensions to enable integration with nbgallery. More information is available here in the nbgallery github project.


This package contains both UI extensions (nbextensions) and server extensions. Install the package with pip, then install the nbextensions with jupyter. Depending on how you have Jupyter installed, you may want to add the --system, --sys-prefix, or --user options; see jupyter nbextension install --help for details.

pip install jupyter_nbgallery
jupyter nbextension install --py jupyter_nbgallery

Next, enable the extensions you want to use. At a minimum, you need the post_hack server extension and the gallery_menu and environment nbextensions to enable the two-way integration with nbgallery.

To enable all extensions:

jupyter serverextension enable --py jupyter_nbgallery
jupyter nbextension enable --py jupyter_nbgallery

To enable extensions independently (note that you need to specify the section for nbextensions):

# Minimal set
jupyter nbextension enable --section common jupyter_nbgallery/environment/environment
jupyter nbextension enable --section notebook jupyter_nbgallery/gallery_menu/gallery_menu
jupyter serverextension enable jupyter_nbgallery.post_hack

# Optional
jupyter nbextension enable --section tree jupyter_nbgallery/autodownload/autodownload
jupyter nbextension enable --section notebook jupyter_nbgallery/easy_buttons/easy_buttons
jupyter nbextension enable --section notebook jupyter_nbgallery/instrumentation/instrumentation

If you are using the Jupyter Nbextensions Configurator extension, you can also toggle the nbextensions on and off from the configurator page.

Jupyter configuration

Once the extension is installed, you will also need to modify your Jupyter configuration to interact with your nbgallery server.

First, your Jupyter instance needs to know about your nbgallery server in order to save notebooks, download preferences, etc. This is configured in nbconfig/common.json underneath one of Jupyter's configuration directories. You can use the included jupyter nbgallery script to set the location of your nbgallery, as well as the Jupyter client name that will appear in nbgallery's "Run in Jupyter" Environments page.

# Set nbgallery server location:
# jupyter nbgallery [--user|--system|--sys-prefix] configure url <nbgallery server address>
# Example:
jupyter nbgallery --sys-prefix configure url http://localhost:3000

# Set nbgallery environment client name
# Example:
jupyter nbgallery --sys-prefix configure my-jupyter-instance

After configuration, nbconfig/common.json should look something like this (potentially with other unrelated sections):

  "nbgallery": {
    "url": "http://localhost:3000",
    "client": {
      "name": "my-jupyter-instance"

Second, in order for nbgallery's "Run in Jupyter" button to work, Jupyter must be configured to allow cross-site AJAX. Note these are security-relevant configuration settings. These can be set in

c.JupyterApp.allow_origin = <URL of your nbgallery instance>`
c.JupyterApp.allow_credentials = True
c.JupyterApp.disable_check_xsrf = True

These can also be set on the command line when launching Jupyter; for example:

jupyter notebook --JupyterApp.allow_origin='http://localhost:3000' --JupyterApp.allow_credentials=True --JupyterApp.disable_check_xsrf=True

List of Extensions

UI Extensions (nbextensions)

Minimal Set

  • environment registers this Jupyter instance with nbgallery so notebooks can be launched with the "Run in Jupyter" button. It also downloads preferences stored in nbgallery.
  • gallery_menu adds the Gallery and Preferences menus to the Notebook interface. These are necessary for saving notebooks and preferences back to nbgallery.


Server Extensions

  • post_hack is a workaround for browser issues with CORS pre-flight checks when PKI certificates are involved. The Jupyter API enables notebooks to be uploaded via a PUT to /api/contents/NotebookName.ipynb; this extension enables uploads via a POST to /post/NotebookName.ipynb as well. The "Run in Jupyter" button in nbgallery uses the /post endpoint, so this extension must be enabled to launch notebooks from nbgallery.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for jupyter-nbgallery, version 1.0.4
Filename, size File type Python version Upload date Hashes
Filename, size jupyter_nbgallery-1.0.4-py3-none-any.whl (81.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size jupyter-nbgallery-1.0.4.tar.gz (80.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page