Skip to content

Commit f1c1cbd

Browse files
committed
Update description
1 parent fdbf42d commit f1c1cbd

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,30 @@ This project provides a way for JupyterLab and other frontends to switch to [Jup
55
## Basic Usage
66

77
Install from PyPI:
8+
89
```
9-
> pip install notebook_shim
10+
pip install notebook_shim
1011
```
12+
1113
This will automatically enable the extension in Jupyter Server.
1214

1315
## Usage
1416

1517
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.
1618

1719
For example, an application class that previously looked like:
20+
1821
```python
1922
from notebook.notebookapp import NotebookApp
2023

2124
class MyApplication(NotebookApp):
2225
```
26+
2327
should switch to look something like:
28+
2429
```python
2530
from jupyter_server.extension.application import ExtensionApp
2631
from notebook_shim.shim import NotebookConfigShimMixin
2732

2833
class MyApplication(NotebookConfigShimMixin, ExtensionApp):
29-
```
30-
34+
```

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[metadata]
22
name = notebook_shim
33
version = attr: notebook_shim._version.__version__
4-
description = Jupyter Notebook as a Jupyter Server extension.
4+
description = A shim layer for notebook traits and config
55
long_description = file: README.md
66
long_description_content_type = text/markdown
77
license_file = LICENSE

0 commit comments

Comments
 (0)