ipyelk
Jupyter Widgets for interactive graphs powered by the Eclipse Layout Kernel (ELK).
| Install | Demo | 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 |
Prerequisites
python >=3.7
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 |
Install
ipyelk is distributed on conda-forge and PyPI.
ipyelk with conda (recommended)
conda install -c conda-forge ipyelk jupyterlab=3
ipyelk with pip
install nodejs with a package manager
pip install ipyelk jupyterlab=3
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
Uninstall
pip uninstall ipyelk
Open Source
This work is licensed under the BSD-3-Clause License. It contains pieces derived from other works.
Metadata
Release files for ipyelk 1.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-1.0.0.tar.gz | 588.4 kB | Without provenance | Details for ipyelk-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ipyelk-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for ipyelk-1.0.0-py3-none-any.whl |
Total release size: 1.7 MB
Release files / ipyelk-1.0.0.tar.gz
| Download URL | ipyelk-1.0.0.tar.gz |
|---|---|
| Size | 588.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
939d0a33fd3f6a4674128dcc6d59ea582633acc58905bd0150208487ec2444ef
|
|
BLAKE2b-256 checksum How to use checksums |
26ce87565824f7915a897839a3bc25768c9acdbee905fadbdd74d52dc7f76193
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.6.0.post20210108 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.9
|
Release files / ipyelk-1.0.0-py3-none-any.whl
| Download URL | ipyelk-1.0.0-py3-none-any.whl |
|---|---|
| Size | 1.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b5d387011882caeab9c93755d43c96558cabf6c90c0cc5c0458a453286796ff8
|
|
BLAKE2b-256 checksum How to use checksums |
31dc5256414a2fde2c4cd43dfe0f603db8a1b30f042922194300f333e8683cbf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.6.0.post20210108 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.9
|
Security for ipyelk 1.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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A 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.