jupyterlab-drawio

A standalone embedding of the FOSS drawio / mxgraph package into jupyterlab

Showing:

Popularity

Downloads/wk

0

GitHub Stars

494

Maintenance

Last Commit

3mos ago

Contributors

16

Package

Dependencies

1

License

BSD-3-Clause

Categories

Readme

jupyterlab-drawio

Github Actions StatusBinder

A JupyterLab extension for embedding drawio / mxgraph.

Requirements

  • JupyterLab >= 3.0

Install

jupyterlab-drawio can be installed with mamba:

mamba install -c conda-forge jupyterlab-drawio

With conda:

conda install -c conda-forge jupyterlab-drawio

With pip:

pip install jupyterlab-drawio

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-drawio 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 jupyterlab-drawio

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial