Notebook Shim

0.2.4 · active · verified Sun Mar 29

Notebook-shim is a Python library that provides a compatibility layer for applications transitioning from `jupyter/notebook` to `jupyter/jupyter_server` as their backend. It specifically helps handle traits and configuration that moved between these two core Jupyter components. The current version is 0.2.4, and it is released on an as-needed basis to support the evolution of the Jupyter ecosystem.

Warnings

breaking Direct inheritance from `notebook.notebookapp.NotebookApp` for server-side extensions is deprecated. You must migrate to `jupyter_server.serverapp.ServerApp` and use `notebook_shim.NotebookConfigShimMixin` for compatibility.
Fix: Change your application's base class from `NotebookApp` to `ServerApp` and include `NotebookConfigShimMixin` in its inheritance list: `class MyExtension(NotebookConfigShimMixin, ServerApp):`.
gotcha The `notebook-shim` library is a compatibility layer, not a full replacement for `jupyter/notebook`. It's designed to ease the transition, but applications should aim for full `jupyter_server` compatibility over time.
Fix: Refer to the `jupyter_server` documentation for best practices on developing extensions and applications natively against `jupyter_server`.
deprecated There is an open issue regarding the deprecation of `_jupyter_server_extension_paths` in `jupyter_server`, which might affect how extensions are discovered or loaded in the future.
Fix: Monitor the `jupyter/notebook_shim` and `jupyter/jupyter_server` GitHub repositories for updates on extension path discovery mechanisms and adapt your extension registration accordingly.

Install

pip install notebook-shim Install with pip

Imports

NotebookConfigShimMixin
```
from notebook_shim import NotebookConfigShimMixin
```
Applications subclassing `NotebookApp` to leverage the Python server backend should now switch to `ExtensionApp` from `jupyter_server` and add `NotebookConfigShimMixin` to handle moved traits.

Quickstart

This quickstart demonstrates the primary use case of `notebook-shim`: integrating `NotebookConfigShimMixin` into an application that now extends `jupyter_server.serverapp.ServerApp` instead of the legacy `notebook.notebookapp.NotebookApp`.

from jupyter_server.serverapp import ServerApp
from notebook_shim import NotebookConfigShimMixin

class MyShimmedApp(NotebookConfigShimMixin, ServerApp):
    # Your application's custom logic here
    pass

if __name__ == '__main__':
    # In a real application, you would run this via `jupyter-server` entrypoints.
    # For a direct example, you can instantiate and start it minimally.
    print("This example demonstrates the import path and class inheritance.")
    print("To run a functional server, integrate MyShimmedApp with jupyter_server's extension system.")

view raw JSON →