---
id: notebook-shim
version: "0.2.4"
license: BSD 3-Clause License Copyright (c) 2022 Project Jupyter Contributors All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that… (full text in the JSON record)
license_treatment: permissive
maintenance: dormant
---

# notebook-shim — A shim layer for notebook traits and config

License: permissive · Maintenance: dormant · Popularity: top 1,000 on PyPI

## Install

pip install notebook-shim
uv add notebook-shim
poetry add notebook-shim

## 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):
```

## AI interpretation — verify before relying

Provides a compatibility layer enabling JupyterLab and other frontends to migrate from the legacy Notebook application to Jupyter Server, including trait shimming for extensions that previously subclassed NotebookApp.

Verdict: A stable, low-friction compatibility bridge for migrating Jupyter extensions from NotebookApp to Jupyter Server. No known vulnerabilities and permissive licensing make it safe to adopt. Dormant maintenance is appropriate for a shim layer; use it if you are actively migrating an extension or frontend.

[View on SkillFed](https://skillfed.io/packages/notebook-shim) · [View on PyPI](https://pypi.org/project/notebook-shim/)