ipydrawio/py_packages/ipydrawio-widgets/README.md

IPyDrawio Widgets

The kernel-side classes for ipydrawio.

This package is useful in situations where your JupyterLab client is configured in another environment than the kernel that might create widgets.

See the main project repo for more information.

Installation

Note: Usually, you'll want the entire ipydrawio suite, replacing ipydrawio-widgets with ipydrawio!

To install just the kernel-side widgets (without any of the front end assets):

pip install ipydrawio-widgets  # or...
mamba install -c conda-forge ipydrawio-widgets  # or...
conda install -c conda-forge ipydrawio-widgets

Usage

Display a basic diagram:

from ipydrawio_widgets import Diagram

diagram = Diagram()
diagram

Update the XML source:

from pathlib import Path
diagram.source.value = Path("a-drawio.dio").read_text()

The .source.value will always contain the up-to-date XML.

For more, see the documentation

Open Source

This work is licensed under the Apache-2.0 License.

Copyright 2023 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.