Go to file
Jeremy Tuloup 530c799b8d
Merge pull request #62 from jtpio/update-contributors
Update to JupyterLab Classic Contributors
2020-12-22 15:16:56 +01:00
.github/workflows Add CI 2020-12-07 18:01:27 +01:00
binder Update the example notebook 2020-12-11 00:44:29 +01:00
builder Release 0.1.0rc2 2020-12-19 12:47:53 +01:00
jupyter-config Add Binder (#2) 2020-12-07 19:55:10 +01:00
jupyterlab_classic Release 0.1.0rc2 2020-12-19 12:47:53 +01:00
packages Release 0.1.0rc2 2020-12-19 12:47:53 +01:00
.eslintignore Initial commit 2020-12-04 15:15:41 +02:00
.eslintrc.js Initial commit 2020-12-04 15:15:41 +02:00
.gitignore Add toolbar button to open in classic 2020-12-07 17:31:37 +01:00
.prettierignore Add CI 2020-12-07 18:01:27 +01:00
.prettierrc Initial commit 2020-12-04 15:15:41 +02:00
CONTRIBUTING.md Update to JupyterLab 3.0.0rc15 2020-12-19 11:10:18 +01:00
lerna.json Release 0.1.0rc2 2020-12-19 12:47:53 +01:00
LICENSE Update to JupyterLab Classic Contributors 2020-12-22 14:55:26 +01:00
lint-staged.config.js Initial commit 2020-12-04 15:15:41 +02:00
MANIFEST.in Ensure static 2020-12-09 22:56:09 +01:00
package.json Update to JupyterLab Classic Contributors 2020-12-22 14:55:26 +01:00
pyproject.toml Update to JupyterLab 3.0.0rc15 2020-12-19 11:10:18 +01:00
README.md Minor wording pass 2020-12-22 12:48:10 +01:00
setup.py Update to JupyterLab Classic Contributors 2020-12-22 14:55:26 +01:00
tsconfig.eslint.json Initial commit 2020-12-04 15:15:41 +02:00
tsconfig.test.json Initial commit 2020-12-04 15:15:41 +02:00
tsconfigbase.json Initial commit 2020-12-04 15:15:41 +02:00
tsconfigbase.test.json Initial commit 2020-12-04 15:15:41 +02:00
yarn.lock Update to TypeScript 4.1.3 2020-12-19 12:40:28 +01:00

jupyterlab-classic

Github Actions Status Binder

The next gen old-school Notebook UI.

image

Install

Pre-releases of jupyterlab-classic are now available!

jupyterlab-classic can be installed with pip:

pip install jupyterlab-classic --pre

And with conda (coming soon):

conda install -c conda-forge jupyterlab-classic

Usage

jupyterlab-classic can be started as a standalone app with:

jupyter classic

Existing federated JupyterLab extensions listed via:

jupyter labextension list

Should also be available when starting jupyterlab-classic.

Files 📂 and Running Sessions 🏃‍♀️

tree

Notebook 📒

notebook

Open in a new Browser Tab by default

new-browser-tab

Command Palette 🎨

command-palette

Themes 🌈

Support for existing JupyterLab themes!

themes

Zen Mode 😌

compact-zen-mode

Terminals 🖥️

terminals

File Editor 🖊️

image

Compact View on Mobile Devices 📱

mobile

Support for federated extensions 🧩

Install new extensions easily!

federated-extensions

Switch between JupyterLab and JupyterLab Classic easily ↔️

jupyterlab-switch

Contributing

If you would like to contribute to the project and set up a development environment, check out CONTRIBUTING.md.

Motivation

JupyterLab is the next-gen UI for Project Jupyter. Approaching version 3.0, it is becoming more mature and provides an advanced computational environment, that can sometimes be compared to what traditional IDEs offer.

However in some cases, having a leaner, simpler, and more focused interface to work on a notebook is really useful.

The single document mode as currently implemented in JupyterLab helps address this issue, but still displays a couple of visual cues that can be distracting to some users.

The goal of the jupyterlab-classic project is to look as close to the classic notebook UI as possible, while leveraging the efforts put in the development of JupyterLab itself and its extension system.

Technically speaking, jupyterlab-classic reuses many of the existing plugins for JupyterLab (notebook, toolbar), and also supports pre-built (federated) third-party extensions using the new distribution system added in 3.0. That way, extensions built for JupyterLab should also be compatible with jupyterlab-classic, as long as they can be added to the application shell provided by JupyterLab Classic.

Relation to other Jupyter frontends

Jupyterlab Classic is an alternative frontend built using the latest JupyterLab components, with the look and feel of the Classic Jupyter Notebook UI. Below is a short comparison to know where it stands when compared to other Jupyter UI projects:

  • Classic Jupyter Notebook - Classic frontend, classic notebook server.
  • NBClassic - Classic frontend, new Jupyter Server.
  • JupyterLab - Jupyterlab frontend, new Jupyter Server (or Classic Notebook Server). Extensions are not compatible with the Classic Jupyter Notebook since it is built with different components. With version 3.0 onwards, it uses the new Jupyter Server and supports federated extensions that don't need to be rebuilt on the end-user machine.
  • Jupyterlab Classic - JupyterLab frontend built with JupyterLab components, with the look and feel of the Classic Notebook. Consistent with the latest version of Jupyterlab. Extensions built for Jupyterlab should work as long as the components they depend on are part of this classic interface (for install JupyterLab Classic doesn't have the left, right and bottom areas).

Prior art

This project is mostly a reboot of the two previous attempts at making something similar:

These projects really expressed the need for a stripped down, minimal version of the Jupyter Notebook UI.

jupyterlab-classic contributes to that space with the added features:

  • Support for existing federated (prebuilt) JupyterLab extensions
  • Zen Mode
  • Repo structure, similar to JupyterLab
  • Reusing as much as possible from upstream JupyterLab