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

Warning: anywidget is new and under active development. It is not yet ready for production as APIs are subject to change.

anywidget is available on PyPI and may be installed with pip:

pip install "anywidget[dev]"

It is also available on conda-forge. If you have Anaconda or Miniconda installed on your computer, you can install anywidget with the following command:

conda install -c conda-forge anywidget

Usage

import anywidget
import traitlets

class CounterWidget(anywidget.AnyWidget):
    # Widget front-end JavaScript code
    _esm = """
    export 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);
    }
    """
    # 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.

Contributing

See CONTRIBUTING.md for information on how to develop anywidget locally.

License

MIT

Metadata

Release files for anywidget 0.7.1

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.7.1
File	Size	Uploaded
anywidget-0.7.1.tar.gz	3.1 MB	Oct 24, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for anywidget 0.7.1
File	Interpreter	ABI	Platform	Reset
anywidget-0.7.1-py3-none-any.whl 40.2 kB Oct 24, 2023	Python 3	none	any	Details

Total release size: 3.1 MB

Release files / anywidget-0.7.1.tar.gz

Download URL	anywidget-0.7.1.tar.gz
Size	3.1 MB
Tags	Source
SHA-256 checksum How to use checksums	`1c4cb51063f8ec5172b8c8efb1bfb79861d340c3491220d56b8c2a6aa8db3b3d`
BLAKE2b-256 checksum How to use checksums	`ddfa5b06f4c0ba414c741771a369f0dd6a40f6bc5395af59ba7365d4dff965e7`
Upload date	Oct 24, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.6`

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

Download URL	anywidget-0.7.1-py3-none-any.whl
Size	40.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`17828c6e255a7066c960636cbda045d55b08c996a2fc4e886e4c8507db6e9407`
BLAKE2b-256 checksum How to use checksums	`78fa72bd0b3125819ec30d5464a80b8215e8789c7c34cc85f9fdd5b7ae599fba`
Upload date	Oct 24, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.6`