Bidirectional communication for the HoloViz ecosystem.
There are two installable components in this repository: a Python
component used by various HoloViz tools and an extension to enable
Jupyterlab support. For JupyterLab 3.0 the extension is automatically
bundled with the
pyviz_comms Python package.
Installing the Jupyterlab extension
Jupyterlab users will need to install the Jupyterlab pyviz extension. Starting with JupyterLab 3.0 the extension will be automatically installed when installing
pip install pyviz_comms
conda install -c pyviz pyviz_comms
For older versions of JupyterLab you must separately install:
jupyter labextension install @pyviz/jupyterlab_pyviz
Our goal is that
jupyterlab_pyviz minor releases (using the SemVer pattern) are
made to follow JupyterLab minor release bumps and micro releases are for new
or bug fix releases. We've been previously inconsistent with having the extension release minor version bumps
track that of JupyterLab, so users seeking to find extension releases that are compatible with their JupyterLab
installation may refer to the below table.
Compatible JupyterLab and jupyterlab_pyviz versions
Developing the Jupyterlab extension
Note: You will need NodeJS to build the extension package.
jlpm command is JupyterLab's pinned version of
yarn that is installed with JupyterLab. You may use
npm in lieu of
# Clone the repo to your local environment # Change directory to the holoviz_jlab directory # Install package in development mode pip install -e . # Link your development version of the extension with JupyterLab jupyter labextension develop . --overwrite # Rebuild extension Typescript source after making changes jlpm run build
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
# Watch the source directory in one terminal, automatically rebuilding when needed jlpm run watch # Run JupyterLab in another terminal jupyter lab
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the
jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
jupyter lab build --minimize=False
Release history Release notifications | RSS feed
Hashes for pyviz_comms-2.0.1-py2.py3-none-any.whl