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 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

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.

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!

License

MIT

Metadata

Release files for anywidget 0.9.8

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.8
File	Size	Uploaded
anywidget-0.9.8.tar.gz	8.8 MB	Apr 19, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for anywidget 0.9.8
File	Interpreter	ABI	Platform	Reset
anywidget-0.9.8-py3-none-any.whl 247.0 kB Apr 19, 2024	Python 3	none	any	Details

Total release size: 9.0 MB

Release files / anywidget-0.9.8.tar.gz

Download URL	anywidget-0.9.8.tar.gz
Size	8.8 MB
Tags	Source
SHA-256 checksum How to use checksums	`61a9acb153f4f82e0d5d28bf86e8077bd55e3b251e2c6cc74f3a0014407400e9`
BLAKE2b-256 checksum How to use checksums	`a7694bf33bafbd4320798ca4caeff38f0b105370d00458782a48e76eada782b4`
Upload date	Apr 19, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.0.0 CPython/3.11.9`

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

Download URL	anywidget-0.9.8-py3-none-any.whl
Size	247.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`0dc8dbd09038ffc8ea6c90348f345f35bfc772ca90022811939e6ba5c9eca831`
BLAKE2b-256 checksum How to use checksums	`c985613c882ec0600b630750af4f5cfd279e5fce87da9659685c4a1351efd5b3`
Upload date	Apr 19, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.0.0 CPython/3.11.9`