Skip to content

Latest commit

 

History

History
125 lines (79 loc) · 4.49 KB

README.md

File metadata and controls

125 lines (79 loc) · 4.49 KB
Raw

jupyterlab-interactive-dashboard-editor

Github Actions Status Binder npm version Documentation Status

Interactively create and customize dashboards in JupyterLab

presto-overview

Additional Gifs

Click to expand Add and rearrange outputs on dashboards right from your notebook.

add-move-resize

Add outputs from multiple notebooks.

add-multiple

See changes immediately.

see-changes

Preview your dashboard and interact with widgets in present mode.

present-mode

Undo and redo.

undo-redo

Add markdown too.

markdown-too

Save dashboards to file,

save-dashboard

Load them up,

load-dashboard

And edit them again!

edit-again

Requirements

  • JupyterLab >= 2.0

Install

For JupyterLab 3+:

pip install jupyterlab-interactive-dashboard-editor

For JupyterLab 2.x:

jupyter labextension install jupyterlab-interactive-dashboard-editor
jupyter lab build

Note: You will need NodeJS to install the extension for JupterLab 2.x.

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 jupyterlab-interactive-dashboard-editor 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

For JupyterLab 3+:

pip uninstall -interactive-dashboard-editor

For JupyterLab 2.x:

jupyter labextension uninstall jupyterlab-interactive-dashboard-editor