# notebook-shim

> A shim layer for notebook traits and config

- **URL**: https://www.freshcrate.ai/projects/notebook-shim
- **Author**: pypi
- **Category**: Frameworks
- **Latest version**: `0.2.4` (2026-04-21)
- **License**: non-standard
- **Homepage**: https://pypi.org/project/notebook-shim/
- **Language**: Python
- **Registry**: pypi (`notebook-shim`)
- **Tags**: `ipython`, `jupyter`, `pypi`

## Description

# Notebook Shim

This project provides a way for JupyterLab and other frontends to switch to [Jupyter Server](https://github.com/jupyter/jupyter_server/) for their Python Web application backend.

## Basic Usage

Install from PyPI:

```
pip install notebook_shim
```

This will automatically enable the extension in Jupyter Server.

## Usage

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.

For example, an application class that previously looked like:

```python
from notebook.notebookapp import NotebookApp

class MyApplication(NotebookApp):
```

should switch to look something like:

```python
from jupyter_server.extension.application import ExtensionApp
from notebook_shim.shim import NotebookConfigShimMixin

class MyApplication(NotebookConfigShimMixin, ExtensionApp):
```

## Recent releases

| Version | Date | Urgency | Changes |
| --- | --- | --- | --- |
| `0.2.4` | 2026-04-21 | Low | Imported from PyPI (0.2.4) |

## Citation

- HTML: https://www.freshcrate.ai/projects/notebook-shim
- Markdown: https://www.freshcrate.ai/projects/notebook-shim.md
- Dependencies JSON: https://www.freshcrate.ai/api/projects/notebook-shim/deps

_Generated by freshcrate.ai. Indexes pypi releases for AI-agent ecosystem packages._