Skip to main content

custom jupyter widgets made easy

Project description

anywidget

PyPI License codecov Open In Colab DOI

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

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 getCount = () => model.get("count");
      let button = document.createElement("button");
      button.innerHTML = `count is ${getCount()}`;
      button.addEventListener("click", () => {
        model.set("count", getCount() + 1);
        model.save_changes();
      });
      model.on("change:count", () => {
        button.innerHTML = `count is ${getCount()}`;
      });
      el.appendChild(button);
    }
    """
    # Stateful property that can be accessed by JavaScript & Python
    count = 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")

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

anywidget-0.6.0.tar.gz (3.0 MB view details)

Uploaded Source

Built Distribution

anywidget-0.6.0-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

Details for the file anywidget-0.6.0.tar.gz.

File metadata

  • Download URL: anywidget-0.6.0.tar.gz
  • Upload date:
  • Size: 3.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for anywidget-0.6.0.tar.gz
Algorithm Hash digest
SHA256 3afeefbffdbfac3fb6455bd7d6af7d48aa1d62d3aaaa69ee5df6ccb40d65f885
MD5 e27910fa9585e7a89b745a59c579c528
BLAKE2b-256 651b7fa9e0fbedea0df51a434742cbfe3117b3359cb28ee99ce76e28801bd26b

See more details on using hashes here.

File details

Details for the file anywidget-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: anywidget-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 38.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for anywidget-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e1dbb8c627ee5f72cc3a923cb5142e511e5dee6be5b445e065a7ac19204a5bbf
MD5 7ffe1ce11214275bdd2596cf7d3bef91
BLAKE2b-256 bbd41fcd30d19685546b5c0555ab41e82139287d225a8322e9ede6d22d4cc406

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page