Skip to content

Commit

Permalink
Add documentation for updating notebook imports (#7244)
Browse files Browse the repository at this point in the history
* Add documentation for updating `notebook` imports

* fix typos
  • Loading branch information
jtpio authored Feb 8, 2024
1 parent 5909ff9 commit aef8e95
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/source/configuring/config_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,12 @@ front-end Notebook client (i.e. the familiar notebook interface).
> - Related: [Configuring a language kernel](https://ipython.readthedocs.io/en/latest/install/kernel_install.html)
> to run in the Jupyter Server enables your server to run other languages, like R or Julia.
```{warning}
Jupyter Notebook 7 is now based on Jupyter Server. This may break some previous `notebook` imports you may have been using, such as `notebook.auth` or `notebook.notebookapp`.
Check out the [migration guide](../migrating/server-imports.md) to learn more on how to update these server imports.
```
(configure-nbextensions)=

## Notebook extensions
Expand Down
1 change: 1 addition & 0 deletions docs/source/migrate_to_notebook7.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ notebook_7_features.md
migrating/frontend-extensions.md
migrating/server-extensions.md
migrating/server-imports.md
migrating/custom-themes.md
migrating/multiple-interfaces.md
```
Expand Down
33 changes: 33 additions & 0 deletions docs/source/migrating/server-imports.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Server Imports in Notebook 7

Notebook 7 is now based on Jupyter Server, which lets users run multiple Jupyter frontends (e.g. Notebook, JupyterLab, NBClassic, etc.) on the same server.

Prior to Notebook 7, the Classic Notebook server included the server modules in the `notebook` package. This means it was possible to import the server modules from the `notebook` package, for example:

```python
from notebook.auth import passwd
passwd("foo")
```

Or:

```python
from notebook import notebookapp
notebookapp.list_running_servers()
```

In Notebook 7, these server modules are now exposed by the `jupyter_server` package. The code snippets above should be updated to:

```python
from jupyter_server.auth import passwd
passwd("foo")
```

And:

```python
from jupyter_server import serverapp
serverapp.list_running_servers()
```

These are just examples, so you may have to adjust your use of `notebook` imports based on the specific server modules you were using.

0 comments on commit aef8e95

Please sign in to comment.