Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated main page README. #246

Merged
merged 4 commits into from
Apr 26, 2023
Merged

Updated main page README. #246

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9426d12
Updated README.
ericsnekbytes Apr 25, 2023
59ab02d
Update README.md
ericsnekbytes Apr 25, 2023
eb18511
Refactored using zsailer suggestions.
ericsnekbytes Apr 26, 2023
2c0b544
Added meeting feedback, links to side by side install docs.
ericsnekbytes Apr 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 29 additions & 5 deletions README.md
View file
Open in desktop
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:
TODO: Add info about side by side installs/usage, etc.
Alternatively, you can run Jupyter Server and visit the `/tree` endpoint:

```
> 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/