Skip to main content

Run ImJoy plugins in JupyterLab

Project description

imjoy-jupyterlab-extension

Github Actions Status

Run ImJoy plugins in JupyterLab

Requirements

  • JupyterLab >= 3.0

Install

pip install imjoy-jupyterlab-extension

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 imjoy-jupyterlab-extension directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run 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 run 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 run 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

Uninstall

pip uninstall imjoy-jupyterlab-extension

Note

npm run watch:labextension
pip install jupyter_packaging
npm run install:extension
jupyter lab

Publish

The setup.py script will rebuild the static files, therefore run:

sh publish.sh

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

imjoy-jupyterlab-extension-0.1.13.tar.gz (237.3 kB view details)

Uploaded Source

Built Distribution

imjoy_jupyterlab_extension-0.1.13-py3-none-any.whl (98.3 kB view details)

Uploaded Python 3

File details

Details for the file imjoy-jupyterlab-extension-0.1.13.tar.gz.

File metadata

File hashes

Hashes for imjoy-jupyterlab-extension-0.1.13.tar.gz
Algorithm Hash digest
SHA256 2cc83e630cdbc86693f1e8fa2c8823684f632edac7276335d5ca3732d6567f7f
MD5 622c59eb7b757f048678c76f49238d1c
BLAKE2b-256 1c410ac7be3d0a54e890932d649a45e11f9c4047aecee2e00ee6ad172f849dd7

See more details on using hashes here.

File details

Details for the file imjoy_jupyterlab_extension-0.1.13-py3-none-any.whl.

File metadata

File hashes

Hashes for imjoy_jupyterlab_extension-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 68c17e89e06d0e484fe2c7a27eb02970f06a4e6dd6798961536c418c26571d1c
MD5 da84ba2a2d2a2f7968074e02b192356e
BLAKE2b-256 15efd7553d9968f317d02ee3e7819be5c9fc6cfa48e9fb3cf0cf92043c6a4205

See more details on using hashes here.

Supported by

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