You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-3Lines changed: 7 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,26 +5,30 @@ This project provides a way for JupyterLab and other frontends to switch to [Jup
5
5
## Basic Usage
6
6
7
7
Install from PyPI:
8
+
8
9
```
9
-
> pip install notebook_shim
10
+
pip install notebook_shim
10
11
```
12
+
11
13
This will automatically enable the extension in Jupyter Server.
12
14
13
15
## Usage
14
16
15
17
This project also includes an API for shimming traits that moved from `NotebookApp` in to `ServerApp` in Jupyter Server. This can be used by applications that subclassed `NotebookApp` to leverage the Python server backend of Jupyter Notebooks. Such extensions should *now* switch to `ExtensionApp` API in Jupyter Server and add `NotebookConfigShimMixin` in their inheritance list to properly handle moved traits.
16
18
17
19
For example, an application class that previously looked like:
20
+
18
21
```python
19
22
from notebook.notebookapp import NotebookApp
20
23
21
24
classMyApplication(NotebookApp):
22
25
```
26
+
23
27
should switch to look something like:
28
+
24
29
```python
25
30
from jupyter_server.extension.application import ExtensionApp
26
31
from notebook_shim.shim import NotebookConfigShimMixin
0 commit comments