notebook-shim
A shim layer for notebook traits and config
Decision gist · record as of 2026-08-14
Yes, if you are maintaining or extending an older Jupyter notebook application and need to migrate to Jupyter Server without a full rewrite. No, if you are building new extensions—use ExtensionApp directly. Be aware the package is dormant (last release 912 days ago) and should be considered legacy infrastructure; verify compatibility with your target Jupyter Server version before relying on it for new deployments.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Low friction installation with a single pure-Python wheel dependency on jupyter-server.
- However, the package is dormant—last release was 912 days ago—so it receives no active maintenance and should be treated as legacy infrastructure rather than an actively developed tool.
License · maintenance · safety
permissive license (permissive) — BSD 3-Clause License permits commercial and private use with minimal restrictions, requiring only retention of copyright notice and disclaimer. No notable licensing constraints for most users.
last release 2024-02-14 (912 days)
0 known vulnerabilities (OSV.dev, 2026-08-14) · 39,008,962 downloads/mo, #702 on PyPI
Alternatives
Verify before relying
pip install notebook_shim
from jupyter_server.extension.application import ExtensionApp
from notebook_shim.shim import NotebookConfigShimMixin
class MyApplication(NotebookConfigShimMixin, ExtensionApp):
pass- Whether the shim handles all trait migrations from NotebookApp to ServerApp or only a subset
- Current compatibility status with recent Jupyter Server versions beyond the last release date
- Whether dormancy indicates the shim is now obsolete or simply stable and no longer needs updates
What it is and what it does
Notebook Shim is a compatibility bridge that helps Jupyter extensions and applications transition from the legacy notebook architecture to Jupyter Server. It provides two main capabilities: automatic enablement as an extension in Jupyter Server, and a mixin class (`NotebookConfigShimMixin`) that maps configuration traits that moved from `NotebookApp` to `ServerApp` during the server migration.
The package is designed for extension developers whose code previously subclassed `NotebookApp`. Rather than rewriting trait handling, developers can now inherit from both `NotebookConfigShimMixin` and the new `ExtensionApp` API to maintain backward compatibility with existing configuration while running on the modern Jupyter Server backend. It depends solely on jupyter-server and installs as a pure-Python wheel.
Use it for
- Migrating a custom Jupyter extension from the legacy notebook backend to Jupyter Server without rewriting all trait definitions
- Enabling an old NotebookApp-based application to run under Jupyter Server by mixing in the shim's trait adapter
- Maintaining backward compatibility for configuration files when switching a Jupyter-based tool to the new server architecture
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you are maintaining or extending an older Jupyter notebook application and need to migrate to Jupyter Server without a full rewrite.
No, if you are building new extensions—use ExtensionApp directly. Be aware the package is dormant (last release 912 days ago) and should be considered legacy infrastructure; verify compatibility with your target Jupyter Server version before relying on it for new deployments.
Install
notebook-shim on PyPI
Before you install
Low friction installation with a single pure-Python wheel dependency on jupyter-server. However, the package is dormant—last release was 912 days ago—so it receives no active maintenance and should be treated as legacy infrastructure rather than an actively developed tool.
License in practice
BSD 3-Clause License permits commercial and private use with minimal restrictions, requiring only retention of copyright notice and disclaimer. No notable licensing constraints for most users.
Quickstart
pip install notebook_shim
from jupyter_server.extension.application import ExtensionApp
from notebook_shim.shim import NotebookConfigShimMixin
class MyApplication(NotebookConfigShimMixin, ExtensionApp):
passVerify before relying
- Whether the shim handles all trait migrations from NotebookApp to ServerApp or only a subset
- Current compatibility status with recent Jupyter Server versions beyond the last release date
- Whether dormancy indicates the shim is now obsolete or simply stable and no longer needs updates
Package facts
| License | permissive license permissive |
| Python support | Supports the current Python release >=3.7 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagejupyter-server |
| Maintenance | Dormant 912 days since the last release |
| First released | |
| Downloads | 39,008,962 / month, #702 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Framework :: JupyterIntended Audience :: DevelopersIntended Audience :: Science/ResearchIntended Audience :: System AdministratorsLicense :: OSI Approved :: BSD LicenseProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.7Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9 |
Evidence: notebook_shim-0.2.4-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “jupyter notebook to server migration”
- notebook-shimProvides a compatibility layer that allows Jupyter extensions and…
- nbclassicProvides the classic Jupyter Notebook interface as a Jupyter Server…
- jupyter-serverJupyter Server provides the backend services, APIs, and REST…
Give your agent the search over MCP, or paste the wish link into any chat.
More Application Frameworks packages
FastAPI is a Python web framework for building REST APIs using type hints, with automatic request validation, serialization, and interactive API documentation.
Provides a way to document function parameters, class attributes, return types, and variables inline using Python's `Annotated` type hint syntax instead of traditional docstrings.
Textual is a Python framework for building cross-platform user interfaces that run in the terminal or web browser using a modern, component-based API.
Install it if you're developing CLI tools, dashboards, or interactive terminal applications.
Typer builds command-line applications from Python functions using type hints, automatically generating help text, argument parsing, and shell completion.
Install it if you are building CLIs in Python.
Build and connect to Model Context Protocol servers that expose tools, resources, and prompts to LLM applications over stdio, HTTP, or SSE transports.
Install it if you need to build or connect to servers.
Werkzeug is a WSGI utility library providing request/response objects, URL routing, an interactive debugger, HTTP utilities, and a development server for building web applications.
See also nbclassic · jupyter-server · jupyter-contrib-core · jupyterlab-server · jupyterlab · jupyter-server-documents · widgetsnbextension · voila · jupyterlab-git · jupyter-lsp