custom jupyter widgets made easy
Project description
anywidget 
custom jupyter widgets made easy
- 🛠️ create widgets without complicated cookiecutter templates
- 📚 publish to PyPI like any other Python package
- 🤖 prototype within
.ipynbor.pyfiles - 🚀 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 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file anywidget-0.6.5.tar.gz.
File metadata
- Download URL: anywidget-0.6.5.tar.gz
- Upload date:
- Size: 3.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a6bae24aabf2d92f544675df4c463cf25b2c53bd7f715dfc7a0488aa72c713e4 |
|
| MD5 | c0eb850821426b06a903c648f711680d |
|
| BLAKE2b-256 | 5b8be3158b7bfaa09fa3474aab9b443aee239d401355f298bc6f2d4bc952b92f |
File details
Details for the file anywidget-0.6.5-py3-none-any.whl.
File metadata
- Download URL: anywidget-0.6.5-py3-none-any.whl
- Upload date:
- Size: 39.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 20e8cabbb5bdb1fdfe114aa18b7418f3480f365e78554f33c2717eb280a97bba |
|
| MD5 | 631388896da4c7efd7086d208bc19697 |
|
| BLAKE2b-256 | 4a6bee40d54ffb641b6bfc4d866b877a5a9e776d9aabe5ca7bdfeb2540c7fce2 |
