simple, custom Jupyter widgets
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 (optionally) with Vite for instant HMR
Installation
pip install anywidget
Usage
import anywidget
import traitlets
ESM = """
export function render(view) {
let count = () => view.model.get("value");
let btn = document.createElement("button");
btn.innerHTML = `count is ${count()}`;
btn.addEventListener("click", () => {
view.model.set("value", count() + 1);
view.model.save_changes();
});
view.model.on("change:value", () => {
btn.innerHTML = `count is ${count()}`;
});
view.el.appendChild(btn);
}
"""
class CounterWidget(anywidget.AnyWidget):
_esm = ESM
value = traitlets.Int(0).tag(sync=True)
CounterWidget()
Development
pip install -e .
If you are using the classic Jupyter Notebook you need to install the nbextension:
jupyter nbextension install --py --symlink --sys-prefix anywidget
jupyter nbextension enable --py --sys-prefix anywidget
Note for developers:
- the
-epip option allows one to modify the Python code in-place. Restart the kernel in order to see the changes. - the
--symlinkargument on Linux or OS X allows one to modify the JavaScript code in-place. This feature is not available with Windows.
For developing with JupyterLab:
jupyter labextension develop --overwrite anywidget
Release
npm version [major|minor|patch]
git tag -a vX.X.X -m "vX.X.X"
git push --follow-tags
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
anywidget-0.1.0.tar.gz
(11.8 kB
view details)
Built Distribution
anywidget-0.1.0-py3-none-any.whl
(21.3 kB
view details)
File details
Details for the file anywidget-0.1.0.tar.gz.
File metadata
- Download URL: anywidget-0.1.0.tar.gz
- Upload date:
- Size: 11.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f9501dfc7aabc1f6ee8ddc9feafe85bae4e9418d8c17485666cdd556322e9176 |
|
| MD5 | 88b4bab729154036a972fd92e5ae2f4f |
|
| BLAKE2b-256 | e861adb4fa5d544db5c31783408b575816a8f4f2dfb2fd9e14a95db9150a10a7 |
File details
Details for the file anywidget-0.1.0-py3-none-any.whl.
File metadata
- Download URL: anywidget-0.1.0-py3-none-any.whl
- Upload date:
- Size: 21.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b94243cd0b4e3486f32a74976c49bbabd5506e5d1c7b1468fdd24dc79e7729d9 |
|
| MD5 | 1ae3654afc9b20c50bdfaf42d10164d1 |
|
| BLAKE2b-256 | 742c8df8dc42ea8cf3ebfeb0e788580af6b1e1edbbbf347b0572187edcf3e578 |
