Skip to main content

A JupyterLab extension for trame communication layer

Project description

trame-jupyter-extension

Github Actions Status A JupyterLab extension for trame communication layer

This extension is composed of a Python package named trame-jupyter-extension for the server extension and a NPM package named trame-jupyter-extension for the frontend extension.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install trame-jupyter-extension

Uninstall

To remove the extension, execute:

pip uninstall trame-jupyter-extension

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the trame-jupyter-extension directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable trame-jupyter-extension
# Rebuild extension Typescript source after making changes
jlpm build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Development uninstall

# Server extension must be manually disabled in develop mode
jupyter server extension disable trame-jupyter-extension
pip uninstall trame-jupyter-extension

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named trame-jupyter-extension within that folder.

Packaging the extension

See RELEASE

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

trame_jupyter_extension-2.1.1.tar.gz (102.7 kB view details)

Uploaded Source

Built Distribution

trame_jupyter_extension-2.1.1-py3-none-any.whl (19.5 kB view details)

Uploaded Python 3

File details

Details for the file trame_jupyter_extension-2.1.1.tar.gz.

File metadata

File hashes

Hashes for trame_jupyter_extension-2.1.1.tar.gz
Algorithm Hash digest
SHA256 f75965a022ace961ce62065f405da48d6558a8391813f8ea4b28d9df4d70215f
MD5 bfe6901d650fe919af79963ad312e2d9
BLAKE2b-256 8da84674628541fa54f46b8c053d0f31ae656380f7dc968fc3a5a247e4688fa2

See more details on using hashes here.

Provenance

File details

Details for the file trame_jupyter_extension-2.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for trame_jupyter_extension-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c920f6c03b83dce359bf10fb9543f4d118e979dbd03efb44e9f0b9de40bb39e4
MD5 3f68fb8711526dfb073701d76215930d
BLAKE2b-256 33deaf72f03be63f8ef25640d24e618e42181799ffe9453aed633eb183f7bd18

See more details on using hashes here.

Provenance

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