custom jupyter widgets made easy
Project description
anywidget
custom jupyter widgets made easy
installation .
docs .
community .
learn
About
anywidget uses modern web standards to simplify authoring and distributing custom Jupyter Widgets.
- 🛠️ 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
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.
Packages
Beyond the primary Python package, anywidget provides an ecosystem of tooling to help you build and distribute custom Jupyter Widgets.
| Name | Description | Version (click for changelogs) |
|---|---|---|
anywidget |
Primary Python package |  |
npm:@anywidget/types |
Client type declarations |  |
npm:@anywidget/vite |
Vite plugin |  |
npm:@anywidget/react |
React framework adapter |  |
npm:@anywidget/svelte |
Svelte framework adapter |  |
npm:create-anywidget |
CLI to bootstrap a new project |  |
jsr:@anywidget/deno |
Backend for Deno Jupyter kernel |  |
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
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.9.10.tar.gz.
File metadata
- Download URL: anywidget-0.9.10.tar.gz
- Upload date:
- Size: 8.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 390a628240981c09813c7523279ddcab82ff4fd3287add5433b78b1369089068 |
|
| MD5 | 8bbad6abd855b7e08d09f74a41fe6423 |
|
| BLAKE2b-256 | d800fbc05915b1629c6393606f3f19ee737e0607f239dfcc6e333fd39dea36d3 |
File details
Details for the file anywidget-0.9.10-py3-none-any.whl.
File metadata
- Download URL: anywidget-0.9.10-py3-none-any.whl
- Upload date:
- Size: 247.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4cdd29d098a3174002fdac3abc2f2e5b0cb25e0d00b757dadd168dc2ec03c2c4 |
|
| MD5 | 9b7de7520c179ec3b22f1ef3bb87272b |
|
| BLAKE2b-256 | 4788448304d5938e295ef3527f873fd7a08c74cfed7afcd868637a09c981899c |
