2020-12-04 21:15:41 +08:00
# jupyterlab-classic
2020-12-08 00:51:17 +08:00
2020-12-11 07:45:04 +08:00
[](https://mybinder.org/v2/gh/jtpio/jupyterlab-classic/main?urlpath=classic/notebooks/binder/example.ipynb)
2020-12-08 00:51:17 +08:00
2020-12-04 21:15:41 +08:00
The next gen old-school Notebook UI.
2020-12-08 00:45:58 +08:00
2020-12-04 21:15:41 +08:00
## Install
2020-12-12 19:53:07 +08:00
**Pre-releases of `jupyterlab-classic` are now available!**
2020-12-10 23:35:16 +08:00
2020-12-12 19:53:07 +08:00
`jupyterlab-classic` can be installed with `pip` :
2020-12-04 21:15:41 +08:00
```bash
2020-12-12 19:53:07 +08:00
pip install jupyterlab-classic --pre
2020-12-04 21:15:41 +08:00
```
2020-12-12 19:53:07 +08:00
And with `conda` (coming soon):
2020-12-04 21:15:41 +08:00
```bash
conda install -c conda-forge jupyterlab-classic
```
## Usage
`jupyterlab-classic` can be started as a standalone app with:
```bash
2020-12-11 18:01:05 +08:00
jupyter classic
2020-12-04 21:15:41 +08:00
```
Existing federated JupyterLab extensions listed via:
```bash
jupyter labextension list
```
Should also be available when starting `jupyterlab-classic` .
2020-12-12 05:11:47 +08:00
### Files 📂 and Running Sessions 🏃♀️
2020-12-09 03:50:57 +08:00
2020-12-12 05:11:47 +08:00
### Notebook 📒
### Open in a new Browser Tab by default
### Command Palette 🎨
### Themes 🌈
Support for existing JupyterLab themes!
### Zen Mode 😌
### Terminals 🖥️
### File Editor 🖊️
### Compact View on Mobile Devices 📱
2020-12-13 05:33:31 +08:00
2020-12-12 05:11:47 +08:00
### Support for federated extensions 🧩
Install new extensions easily!
### Switch between JupyterLab and JupyterLab Classic easily ↔️
2020-12-09 03:50:57 +08:00
2020-12-04 21:15:41 +08:00
## Motivation
2020-12-08 00:45:58 +08:00
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.
2020-12-04 21:15:41 +08:00
However in some cases, having a leaner, simpler, and more focused interface to work on a notebook is really useful.
2020-12-08 00:45:58 +08:00
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.
2020-12-04 21:15:41 +08:00
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.
2020-12-08 00:45:58 +08:00
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.
2020-12-04 21:15:41 +08:00
## Prior art
This project is mostly a reboot of the two previous attempts at making something similar:
- [simplest-notebook ](https://github.com/yuvipanda/simplest-notebook )
- [jupyterlab-clarity-mode ](https://github.com/jupytercalpoly/jupyterlab-clarity-mode )
2020-12-08 00:45:58 +08:00
These projects really expressed the need for a stripped down, minimal version of the Jupyter Notebook UI.
2020-12-04 21:15:41 +08:00
2020-12-08 00:45:58 +08:00
`jupyterlab-classic` contributes to that space with the added features:
2020-12-04 21:15:41 +08:00
- Support for existing federated (prebuilt) JupyterLab extensions
2020-12-08 00:45:58 +08:00
- Zen Mode
2020-12-04 21:15:41 +08:00
- Repo structure, similar to JupyterLab
- Reusing as much as possible from upstream JupyterLab
