ipyelk
Jupyter Widgets for interactive graphs powered by the Eclipse Layout Kernel (ELK).
| Install | Build | Docs |
|---|---|---|
Examples CHANGELOG CONTRIBUTING |
Screenshots
| what can you do... | ... with ipyelk |
|---|---|
| automatically lay out complex, nested data as diagrams | |
| interactive activity/flow-chart diagrams | |
| collapsible blocks | |
| visual simulations | |
| embed other widgets in diagrams | |
| interact with dynamic systems |
Prerequisites
python >=3.10
JupyterLab compatibility
jupyterlab |
ipyelk |
special concerns |
|---|---|---|
==1.* |
>1 |
needs nodejs >10jupyter labextension install @jupyrdf/jupyter-elkbackports, etc. land on the 0.3.x branch |
==2.* |
>1 |
untested |
==3.* |
>=1,<2.1 |
|
>=4.1,<5 |
>=2.1 |
Install
ipyelk is distributed on conda-forge and PyPI.
To upgrade from ipyelk 2.x, read Migrating from ipyelk 2.x to 3.0.
ipyelk with conda (recommended)
conda install -c conda-forge ipyelk "jupyterlab>=4.1,<5"
# or
mamba install -c conda-forge ipyelk "jupyterlab>=4.1,<5"
ipyelk with pip
pip install ipyelk "jupyterlab>=4.1,<5"
Developing
See CONTRIBUTING for a development install.
How it works
In your kernel, ipyelk:
In your jupyter_server:
- serve the
@jupyrdf/jupyter-elkassets as a federated module
In the browser, @jupyrdf/jupyter-elk:
- ELK lays out the diagram in a WebWorker
- sprotty draws the diagram as SVG
- interaction information (like selection and hovering) are passed back to the browser
For upstream widget limitations and their workarounds, see the known issues in the changelog.
Uninstall
pip uninstall ipyelk
Open Source
This work is licensed under the BSD-3-Clause License. Some of its source
files are derived from other works under the Eclipse Public License 1.0 or
2.0, and it bundles JavaScript packages under the Eclipse Public License 2.0. So the
package's license expression is BSD-3-Clause AND EPL-1.0 AND EPL-2.0.
Metadata
Release files for ipyelk 3.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ipyelk-3.0.0.tar.gz | 2.5 MB | With provenance | Details for ipyelk-3.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ipyelk-3.0.0-py3-none-any.whl | Python 3 | none | any | Details for ipyelk-3.0.0-py3-none-any.whl |
Total release size: 5.0 MB
Release files / ipyelk-3.0.0.tar.gz
| Download URL | ipyelk-3.0.0.tar.gz |
|---|---|
| Size | 2.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b14446bcb39492bc58beb8418471fe844978297b08fb58757df31aad05830ea5
|
|
BLAKE2b-256 checksum How to use checksums |
97f0b67139d36f0687143914b023901288ed911bac833573de1660421db4c6a8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 6, 2026.
Transparency logRelease files / ipyelk-3.0.0-py3-none-any.whl
| Download URL | ipyelk-3.0.0-py3-none-any.whl |
|---|---|
| Size | 2.5 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4c69b90ed13a0d2d112477c838980ed9b30bc5bea00b597afe0b95d561ba4ced
|
|
BLAKE2b-256 checksum How to use checksums |
35a9f7cd45e2192cb3c210db0a4a2c8dcd26e6e7d6bebc9b21428cff74990369
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 6, 2026.
Transparency logSecurity for ipyelk 3.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for ipyelk-3.0.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 6, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.