IPyDrawio Export

PDF export of drawio diagrams for JupyterLab.

See the main project repo for more information.

Installation

Note: the mamba/conda installation method ensures nodejs is available

mamba install -c conda-forge ipydrawio-export  # recommended, or...
conda install -c conda-forge ipydrawio-export  # or...
pip install ipydrawio-export

Server Extension

ipydrawio-export runs as a server extension. When installed, it should be automatically configured. If problems arise, it can be manually enabled:

jupyter server extension list   # If you don't see it here...
jupyter server extension enable --sys-prefix --py ipydrawio_export  # run this...
jupyter server extension list   # ... then check it again

Note: If you are starting your server with jupyter notebook (not jupyter lab), the commands above will be serverextension instead of server extension!

Command-Line Usage

Exporting PDF

PDF can also be generated from the command line:

jupyter drawio-export pdf some_file.dio

If needed, the nodejs application will be installed into the Jupyter data path.

jupyter config --paths  # it uses the one in the environment

In the future, it's hoped this can be packaged more conveniently.

Provisioning

To ensure the nodejs application is installed without exporting a PDF (e.g when building a docker container).

jupyter ipydrawio-export provision

Provision locations

If defined, these environment variables will be respected, and an ipydrawio_export folder will be created within:

• $JUPYTER_DATA_DIR
• $IPYDRAWIO_DATA_DIR

Otherwise, ipydrawio-export will provision its files into {sys.prefix}/share/jupyter/ipydrawio_export.

Of note:

• access to the internet is required
• this location must be writeable by the user
• there must be about 400MiB available, primarily for puppeteer's chromium

The effective location can be verified with:

jupyter ipydrawio-export provision --workdir

Open Source

This work is licensed under the Apache-2.0 License.

The vendored code from @jgraph/draw-image-export2 is also licensed under the Apache-2.0 License.

Copyright 2022 ipydrawio contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.