Jupyter Nbextensions Configurator

0.6.4 · active · verified Mon Apr 13

Jupyter Nbextensions Configurator is a Jupyter server extension that provides graphical user interfaces for configuring notebook extensions (nbextensions). It allows users to enable or disable nbextensions and, for those with appropriate YAML descriptor files, to configure their specific options and view their README documentation. The library is currently at version 0.6.4 and is actively maintained with periodic releases addressing compatibility and bug fixes.

Warnings

breaking Jupyter Notebook v7 (and newer versions based on JupyterLab) fundamentally changed the extension system. While `jupyter_nbextensions_configurator` version 0.6.4 includes fixes for its own compatibility with Notebook v7, many of the individual nbextensions it is designed to manage (especially those from `jupyter_contrib_nbextensions`) are not compatible with Notebook v7 and will not function correctly.
Fix: For full compatibility with older nbextensions, consider running Jupyter Notebook v6 or using `nbclassic` (pip install nbclassic) alongside newer Jupyter versions to provide a compatible environment. Check individual nbextension compatibility.
gotcha After installing the Python package, the server extension must be explicitly enabled using a `jupyter` subcommand. Failing to do so will result in the 'Nbextensions' tab not appearing in your Jupyter Notebook interface.
Fix: Run `jupyter nbextensions_configurator enable --user` (or `--system`, `--sys-prefix` as appropriate) after `pip install`. Remember to restart your Jupyter Notebook server afterwards.
gotcha Upgrading or migrating from older installations of nbextensions or `jupyter_contrib_nbextensions` can lead to duplicate entries or 'incompatible' warnings in the configurator interface. This often happens due to leftover files in Jupyter data directories.
Fix: Consult the `jupyter_contrib_nbextensions` troubleshooting guide for steps to remove duplicate entries, which often involves uninstalling old versions and manually cleaning Jupyter data directories using `jupyter --paths` to locate relevant paths.
gotcha Some nbextensions may not load or function correctly in very large Jupyter notebooks due to JavaScript `requirejs` timeouts. This is an issue related to Jupyter's frontend loading mechanism.
Fix: To mitigate, increase the `requirejs` timeout by adding `window.requirejs.config({waitseconds: 60});` (or a higher value) to your `custom.js` file. The location of `custom.js` can be found in Jupyter Notebook documentation.

Install

pip install jupyter_nbextensions_configurator jupyter nbextensions_configurator enable --user pip install and enable for user
conda install -c conda-forge jupyter_nbextensions_configurator conda install

Quickstart

Install the `jupyter_nbextensions_configurator` package, then enable its server extension. After restarting your Jupyter Notebook server, a new 'Nbextensions' tab will appear on the Jupyter home page (file browser), allowing you to manage and configure all detected notebook extensions.

# 1. Install the configurator (if not already installed)
pip install jupyter_nbextensions_configurator

# 2. Enable the server extension for the current user
jupyter nbextensions_configurator enable --user

# 3. Start Jupyter Notebook
jupyter notebook

# After starting Jupyter, open your web browser to the Jupyter home page.
# You should see a new 'Nbextensions' tab. Click it to manage and configure
# your installed notebook extensions.

view raw JSON →