Registry / devops / jupyter-nbextensions-configurator

jupyter-nbextensions-configurator

JSON →
library0.6.4pypypiunverified

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.

pip install jupyter_nbextensions_configurator jupyter nbextensions_configurator enable --user
INSTALL
IMPORT
SIG · JUPYTER-NBEXTENSIO
J
jupyter-nbextensions-configurator
devopspythonv0.6.4
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

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.
Debug
Known issues
breakingJupyter 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.
affects: <0.6.4 (configurator itself), all versions (for many managed nbextensions on Notebook v7+)
gotchaAfter 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.
affects: All versions
gotchaUpgrading 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.
affects: All versions, particularly after migrations or upgrades
gotchaSome 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.
affects: All versions, depending on notebook size and specific extensions
Errors
Common errors & fixes
ModuleNotFoundError: No module named 'jupyter_nbextensions_configurator'
This error typically occurs when the `jupyter-nbextensions-configurator` Python package is not installed in the active Python environment from which Jupyter Notebook/Lab is launched, or its server extension is not properly registered.
fix
Ensure the package is installed and enabled for Jupyter. You might also encounter 'No module named 'notebook.base'', which can be resolved by downgrading `notebook` to a compatible version (e.g., 6.1.5) or ensuring `nbclassic` is installed for newer Jupyter versions.

```bash
pip install jupyter_nbextensions_configurator
jupyter nbextensions_configurator enable --user
# If using Anaconda/Conda:
conda install -c conda-forge jupyter_nbextensions_configurator
jupyter nbextensions_configurator enable --user
# If 'notebook.base' error persists with newer Jupyter versions, consider:
pip install notebook==6.1.5 # Or a version compatible with your nbextensions
# or for JupyterLab with classic notebook interface:
pip install nbclassic
```
Jupyter command 'jupyter-nbextensions_configurator' not found
This error means that the `jupyter-nbextensions_configurator` command-line entry point is not accessible in your system's PATH, or the package itself is not correctly installed and registered as a Jupyter command.
fix
This usually indicates an issue with the installation or environment. Reinstalling the package and ensuring Jupyter's script directories are in your PATH can resolve it. Sometimes, using `python -m jupyter_nbextensions_configurator` explicitly can bypass path issues.

```bash
pip install --upgrade --force-reinstall jupyter_nbextensions_configurator
# Then try enabling again:
jupyter nbextensions_configurator enable --user
# If still not found, check Jupyter's installation paths:
jupyter --paths
# Ensure that the directory containing jupyter_nbextensions_configurator scripts is in your system's PATH.
```
Nbextensions tab not appearing / 404 GET /nbextensions/nbextensions_configurator/tree_tab/main.js
Even if the backend is installed, the frontend assets (JavaScript, CSS) for the configurator might not be correctly installed or served by the Jupyter Notebook server, leading to the 'Nbextensions' tab missing or showing a blank page with 404 errors for resource files like `main.js`. This is often due to version incompatibilities between `jupyter-nbextensions-configurator` and `notebook`/`jupyterlab` or issues with static file serving.
fix
Manually install the nbextension's static files and enable the server extension. Downgrading the `notebook` package to a known working version (e.g., 6.1.5) often resolves compatibility issues with older nbextensions.

```bash
# First, ensure the python package is installed
pip install jupyter_nbextensions_configurator

# Then, install the frontend components and enable the configurator
jupyter nbextension install --sys-prefix --py jupyter_nbextensions_configurator --overwrite
jupyter nbextension enable --sys-prefix --py jupyter_nbextensions_configurator
jupyter serverextension enable --sys-prefix --py jupyter_nbextensions_configurator

# Also ensure jupyter_contrib_nbextensions is installed and its assets too:
pip install jupyter_contrib_nbextensions
jupyter contrib nbextension install --user

# If the issue persists, especially with newer Jupyter versions, consider downgrading:
pip install notebook==6.1.5
```
Upgrade
Version history
0.6.4latest on PyPI · released Jun 5, 2024
Audit
Dependencies
notebookrequiredFunctions as a Jupyter Notebook server extension. Requires a compatible Jupyter Notebook environment to operate. Newer Jupyter versions might require `jupyter_server` instead of `notebook` for core server functionalities, or use `nbclassic` for Notebook v6 compatibility.
jupyter_contrib_nbextensionsrequiredWhile not a direct dependency for the configurator to run, it is the primary collection of nbextensions that this configurator is designed to manage and configure. Often installed together.
Agent activity
3 hits · last 30 days
node
2
Resources
jupyter-nbextensions-configurator — pip install jupyter-nbextensions-configurator · libregistry