Skip to main content

A shim layer for notebook traits and config

Project description

logo
go from data to knowledge

Elixir Shim

This project provides a way for ElixirNote and other frontends to switch to Elixir Server for their Python Web application backend.

Basic Usage

Install from PyPI:

pip install elixir-shim

This will automatically enable the extension in Elixir Server.

Usage

This project also includes an API for shimming traits that moved from NotebookApp in to ServerApp in Elixir Server. This can be used by applications that subclassed NotebookApp to leverage the Python server backend of Elixir Notebooks. Such extensions should now switch to ExtensionApp API in Elixir Server and add NotebookConfigShimMixin in their inheritance list to properly handle moved traits.

For example, an application class that previously looked like:

from notebook.notebookapp import NotebookApp

class MyApplication(NotebookApp):

should switch to look something like:

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

class MyApplication(NotebookConfigShimMixin, ExtensionApp):

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

elixir_shim-0.2.2.tar.gz (10.9 kB view hashes)

Uploaded Source

Built Distribution

elixir_shim-0.2.2-py3-none-any.whl (11.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page