Skip to main content

anywidget logo. A circular icon with two connected arrows pointing clockwise, symbolizing a refresh or restart action
anywidget

reusable widgets made easy

installation . docs . discord . learn

About

anywidget is both a specification and toolkit for authoring reusable web-based widgets for interactive computing environments.

  • 🛠️ create custom Jupyter 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, marimo and more
  • ⚡ develop with instant HMR, like modern web frameworks

Learn more in the Jupyter blog.

Installation

anywidget is available on PyPI:

pip install "anywidget[dev]"

and also on conda-forge:

conda install -c conda-forge anywidget

Usage

The easiest way to start developing with anywidget is with the Python package.

import anywidget
import traitlets

class CounterWidget(anywidget.AnyWidget):
    # Widget front-end JavaScript code
    _esm = """
    function render({ model, el }) {
      let button = document.createElement("button");
      button.innerHTML = `count is ${model.get("value")}`;
      button.addEventListener("click", () => {
        model.set("value", model.get("value") + 1);
        model.save_changes();
      });
      model.on("change:value", () => {
        button.innerHTML = `count is ${model.get("value")}`;
      });
      el.appendChild(button);
    }
    export default { render };
    """
    # Stateful property that can be accessed by JavaScript & Python
    value = traitlets.Int(0).tag(sync=True)

Front-end code can also live in separate files (recommend):

import pathlib
import anywidget
import traitlets

class CounterWidget(anywidget.AnyWidget):
    _esm = pathlib.Path("index.js")
    _css = pathlib.Path("styles.css")
    value = traitlets.Int(0).tag(sync=True)

Read the documentation to learn more.

Packages

Beyond the primary Python package, anywidget provides an ecosystem of tooling to help you build and distribute custom widgets.

Name Description Version (click for changelogs)
anywidget Primary Python package version
npm:@anywidget/types Client type declarations version
npm:@anywidget/vite Vite plugin version
npm:@anywidget/react React framework bridge version
npm:@anywidget/svelte Svelte framework bridge version
npm:create-anywidget CLI to bootstrap a new project version
jsr:@anywidget/deno Backend for Deno Jupyter kernel version
jsr:@anywidget/signals Signals bridge version

Support

Having trouble? Get help in our Discord or open a Discussion.

Contributing

New contributors welcome! Check out our Contributors Guide for help getting started.

Join us on Discord to meet other maintainers. We'll help you get your first contribution in no time!

Citation

If you use anywidget in your work, please consider citing the following publications:

Our JOSS paper describing the overall project and vision:

@article{manz2024anywidget,
  title = {anywidget: reusable widgets for interactive analysis and visualization in computational notebooks},
  volume = {9},
  url = {https://doi.org/10.21105/joss.06939},
  doi = {10.21105/joss.06939},
  number = {102},
  journal = {Journal of Open Source Software},
  author = {Manz, Trevor and Abdennur, Nezar and Gehlenborg, Nils},
  year = {2024},
  note = {Publisher: The Open Journal},
  pages = {6939},
}

Our SciPy paper, detailing the motivation and approach behind Jupyter Widget ecosystem compatibility:

@inproceedings{manz2024notebooks,
  title = {Any notebook served: authoring and sharing reusable interactive widgets},
  copyright = {https://creativecommons.org/licenses/by/4.0/},
  url = {https://doi.org/10.25080/NRPV2311},
  doi = {10.25080/NRPV2311},
  urldate = {2024-10-07},
  booktitle = {Proceedings of the 23rd {Python} in {Science} {Conference}},
  author = {Manz, Trevor and Gehlenborg, Nils and Abdennur, Nezar},
  month = jul,
  year = {2024},
}

Metadata

Release files for anywidget 0.9.21

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.9.21
File Size Uploaded Provenance Actions
anywidget-0.9.21.tar.gz 390.5 kB Without provenance Details for anywidget-0.9.21.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for anywidget 0.9.21
File Interpreter ABI Platform Actions
anywidget-0.9.21-py3-none-any.whl Python 3 none any Details for anywidget-0.9.21-py3-none-any.whl

Total release size: 622.3 kB

Release files / anywidget-0.9.21.tar.gz

Download URL anywidget-0.9.21.tar.gz
Size 390.5 kB
Tags Source
SHA-256 checksum
How to use checksums
b8d0172029ac426573053c416c6a587838661612208bb390fa0607862e594b27
BLAKE2b-256 checksum
How to use checksums
be5ecbea445bf062b81e4d366ca29dae4f0aedc7a64f384afc24670e07bec560
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.0

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

Download URL anywidget-0.9.21-py3-none-any.whl
Size 231.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
78c268e0fbdb1dfd15da37fb578f9cf0a0df58a430e68d9156942b7a9391a761
BLAKE2b-256 checksum
How to use checksums
5b03c17464bbf682ea87e7e3de2ddc63395e359a78ae9c01f55fc78759ecbd79
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.0

Security for anywidget 0.9.21

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.

Release history Release notifications | RSS feed

This release

0.9.21 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page