anywidget v0.9.10
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 (optionally) with Vite for instant HMR
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
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(view) {
let getCount = () => view.model.get("count");
let button = document.createElement("button");
button.innerHTML = `count is ${getCount()}`;
button.addEventListener("click", () => {
view.model.set("count", getCount() + 1);
view.model.save_changes();
});
view.model.on("change:count", () => {
button.innerHTML = `count is ${getCount()}`;
});
view.el.appendChild(button);
}
"""
# Stateful property that can be accessed by JavaScript & Python
count = traitlets.Int(0).tag(sync=True)
Read the documentation to learn more.
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
-e
pip option allows one to modify the Python code in-place. Restart the kernel in order to see the changes. - the
--symlink
argument 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
Sending PRs
Code styling
There are a few guidelines we follow:
- For JavaScript, internal variables are written with
snake_case
while external APIs are written withcamelCase
(if applicable). - For Python, ensure
black --check .
andruff .
pass. You can runblack .
andruff --fix .
to format and fix linting errors.
Generating changelogs
For changes to be reflected in package changelogs, run npx changeset
and
follow the prompts.
Note not every PR requires a changeset. Since changesets are focused on releases and changelogs, changes to the repository that don't effect these won't need a changeset (e.g., documentation, tests).
Release
The Changesets GitHub action will create and update a PR that applies changesets and publishes new versions of anywidget to NPM and PyPI.
15 days ago
20 days ago
22 days ago
1 month ago
1 month ago
1 month ago
1 month ago
2 months ago
3 months ago
3 months ago
3 months ago
4 months ago
5 months ago
10 months ago
7 months ago
10 months ago
8 months ago
8 months ago
7 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
1 year ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago