Skip to main content

PDF export for Drawio diagrams in JupyterLab

Project description

IPyDrawio Export

binder-badge install from pypi install from conda-forge build coverage

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 2021 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.

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

ipydrawio-export-1.1.0.tar.gz (49.5 kB view details)

Uploaded Source

Built Distribution

ipydrawio_export-1.1.0-py3-none-any.whl (68.5 kB view details)

Uploaded Python 3

File details

Details for the file ipydrawio-export-1.1.0.tar.gz.

File metadata

  • Download URL: ipydrawio-export-1.1.0.tar.gz
  • Upload date:
  • Size: 49.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.4

File hashes

Hashes for ipydrawio-export-1.1.0.tar.gz
Algorithm Hash digest
SHA256 16cc720761dca290bc0c14fadbdf23e487c2ba821c09ccf5c1aa9cce9c492fc8
MD5 df3c625024efc553a44ffa1e5c53b7b2
BLAKE2b-256 8329017c97b1f8007aed0e6503df6beb53c5da7b1808a09e8175e90a2700661a

See more details on using hashes here.

Provenance

File details

Details for the file ipydrawio_export-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: ipydrawio_export-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 68.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.4

File hashes

Hashes for ipydrawio_export-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c8a62e7f7ea522bea220729084a8c7ddc983f1bc83198bc7c2e989289d89575e
MD5 4bfcdc7d748d1b1f5babfd4853b1710b
BLAKE2b-256 22fc4a2d7e155ed7d1ba856bb653c3363de39d38c8b0212dafe6f0bb7888f6a7

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