Jupyter NbClassic

Introduction

The nbclassic package is the implementation of the classic Jupyter Notebook 6 as a Jupyter Server extension. As proposed in the accepted Jupyter Enhancement Proposal #79 the development of this package is due to plans being carried out to create a Notebook 7, that is based on the modern JupyterLab code-base.

While Notebook 7 provides a user experience equivalent to that of the classic Notebook 6, the technology stack used is incompatible with that which many Jupyter Notebook users have developed their Jupyter Notebook extensions with. Users may find themselves in need of a way to continue using the Jupyter Notebook 6 tech-stack as they transition to using the Jupyter Notebook 7. The NbClassic package intends to address that need.

You can read more about the migration impacts and coexistence of NbClassic and Notebook package on the NbClassic and Notebook migration plan page.

NbClassic Usage

Installation

Installing from PyPI: pip install nbclassic This will automatically enable the extension in Jupyter Server.

Launch directly: jupyter nbclassic

Alternatively, you can run Jupyter Server and visit the /tree endpoint: jupyter server

Configuration

To create a jupyter_nbclassic_config.py file in the .jupyter directory you can use the following command:

$ jupyter nbclassic --generate-config

Options

You can view a list of the available options by typing:

$ jupyter nbclassic --help

NbClassic Development

Nbclassic is the package that holds the UI components of the classic Jupyter Notebook 6 and serves this UI through the server endpoints provided by Jupyter Server.

Jupyter Server Extensions - Authoring a basic server extension

The jupyter/notebook Repository: The original jupyter/notebook GitHub repository now holds the codebase for the new Jupyter Notebook (version 7).

NbClassic Timeline

As proposed in the JEP #79, the nbclassic package will continue to be supported with critical security fixes in the transition period as users move to using the more modern Jupyter Notebook 7.

Porting Notebook 6 Extensions: Work being done in parallel. ou can find a helpful list of classical Notebook extensions and corresponding Jupyterlab extensions if available at the Jupyterlab-contrib website.