anywidget

custom jupyter widgets made easy

create widgets without complicated cookiecutter templates
publish to PyPI like any other Python package
prototype within .ipynb or .py files
run in Jupyter, JupyterLab, Google Colab, VSCode, and more
develop (optionally) with Vite for instant HMR

Installation

pip install anywidget

Usage

import anywidget
import traitlets

ESM = """
export function render(view) {
  let count = () => view.model.get("value");
  let btn = document.createElement("button");
  btn.innerHTML = `count is ${count()}`;
  btn.addEventListener("click", () => {
    view.model.set("value", count() + 1);
    view.model.save_changes();
  });
  view.model.on("change:value", () => {
    btn.innerHTML = `count is ${count()}`;
  });
  view.el.appendChild(btn);
}
"""

class CounterWidget(anywidget.AnyWidget):
    _esm = ESM
    value = traitlets.Int(0).tag(sync=True)

CounterWidget()

button indicating the number of times it has been clicked

Development

pip install -e .

If you are using the classic Jupyter Notebook you need to install the nbextension:

jupyter nbextension install --py --symlink --sys-prefix anywidget
jupyter nbextension enable --py --sys-prefix anywidget

Note for developers:

the -e pip option allows one to modify the Python code in-place. Restart the kernel in order to see the changes.
the --symlink argument on Linux or OS X allows one to modify the JavaScript code in-place. This feature is not available with Windows.

For developing with JupyterLab:

jupyter labextension develop --overwrite anywidget

Release

npm version [major|minor|patch]
git tag -a vX.X.X -m "vX.X.X"
git push --follow-tags

Release files for anywidget 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for anywidget 0.1.0
File	Size	Uploaded
anywidget-0.1.0.tar.gz	11.8 kB	Jan 20, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for anywidget 0.1.0
File	Interpreter	ABI	Platform	Reset
anywidget-0.1.0-py3-none-any.whl 21.3 kB Jan 20, 2023	Python 3	none	any	Details

Total release size: 33.1 kB

Release files / anywidget-0.1.0.tar.gz

Download URL	anywidget-0.1.0.tar.gz
Size	11.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`f9501dfc7aabc1f6ee8ddc9feafe85bae4e9418d8c17485666cdd556322e9176`
BLAKE2b-256 checksum How to use checksums	`e861adb4fa5d544db5c31783408b575816a8f4f2dfb2fd9e14a95db9150a10a7`
Upload date	Jan 20, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.1`

Release files / anywidget-0.1.0-py3-none-any.whl

Download URL	anywidget-0.1.0-py3-none-any.whl
Size	21.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`b94243cd0b4e3486f32a74976c49bbabd5506e5d1c7b1468fdd24dc79e7729d9`
BLAKE2b-256 checksum How to use checksums	`742c8df8dc42ea8cf3ebfeb0e788580af6b1e1edbbbf347b0572187edcf3e578`
Upload date	Jan 20, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.1`