-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #246 from ericsnekbytes/readme_updates
Updated main page README.
- Loading branch information
Showing
1 changed file
with
29 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,50 @@ | ||
# Jupyter Notebook as a Jupyter Server Extension | ||
# The Classic Jupyter Notebook as a Jupyter Server Extension | ||
|
||
![Testing nbclassic](https://github.com/jupyterlab/nbclassic/workflows/Testing%20nbclassic/badge.svg) | ||
[![Documentation Status](https://readthedocs.org/projects/nbclassic/badge/?version=latest)](https://nbclassic.readthedocs.io/en/latest/?badge=latest) | ||
|
||
NBClassic runs the [Jupyter NbClassic](https://github.com/jupyter/nbclassic) frontend on the Jupyter Server backend. | ||
*Read the full [NbClassic User Manual here]!* | ||
|
||
This project prepares for a future where JupyterLab and other frontends switch to [Jupyter Server](https://github.com/jupyter/jupyter_server/) for their Python Web application backend. Using this package, users can launch Jupyter NbClassic, JupyterLab and other frontends side-by-side on top of the new Python server backend. | ||
The Jupyter Notebook is [evolving to bring you big new features], but it | ||
will also break backwards compatibility with many classic Jupyter Notebook | ||
extensions and customizations. | ||
|
||
NbClassic provides a backwards compatible Jupyter Notebook interface that | ||
you can [install side-by-side] with the latest versions: That way, you can | ||
fearlessly upgrade without worrying about your classic extensions and | ||
customizations breaking. | ||
|
||
## How does it work? | ||
|
||
Because NbClassic provides the classic interface on top of the new [Jupyter | ||
Server] backend, it can coexist with other frontends like JupyterLab and | ||
Notebook 7 in the same installation. NbClassic preserves the custom classic | ||
notebook experience under a new set of URL endpoints, under the namespace | ||
`/nbclassic/`. | ||
|
||
## Basic Usage | ||
|
||
Install from PyPI: | ||
|
||
``` | ||
> pip install nbclassic | ||
``` | ||
This will automatically enable the extension in Jupyter Server. | ||
|
||
This will automatically enable the NbClassic Jupyter Server extension in Jupyter Server. | ||
|
||
Launch directly: | ||
|
||
``` | ||
> jupyter nbclassic | ||
``` | ||
|
||
Alternatively, you can run Jupyter Server and visiting the `/tree` endpoint: | ||
Alternatively, you can run Jupyter Server: | ||
|
||
``` | ||
> jupyter server | ||
``` | ||
|
||
[Jupyter Server]: https://github.com/jupyter/jupyter_server/ | ||
[evolving to bring you big new features]: https://jupyter-notebook.readthedocs.io/en/latest/migrate_to_notebook7.html | ||
[NbClassic User Manual here]: https://nbclassic.readthedocs.io/en/latest/ | ||
[install side-by-side]: https://jupyter-notebook.readthedocs.io/en/latest/migrating/multiple-interfaces.html |