Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manzt/anywidget
reusable widgets made easy
https://github.com/manzt/anywidget
jupyter python widgets
Last synced: 3 days ago
JSON representation
reusable widgets made easy
- Host: GitHub
- URL: https://github.com/manzt/anywidget
- Owner: manzt
- License: mit
- Created: 2022-10-26T00:06:32.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-06T14:15:29.000Z (10 days ago)
- Last Synced: 2024-11-06T14:22:23.022Z (10 days ago)
- Topics: jupyter, python, widgets
- Language: Python
- Homepage: https://anywidget.dev
- Size: 12.5 MB
- Stars: 489
- Watchers: 9
- Forks: 38
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
- awesome-jupyter-widgets - anywidget - custom jupyter widgets made easier (Interactive Widgets / Create Your Own Widget with JavaScript)
README
anywidget
reusable widgets made easy
installation .
docs .
discord .
learn
## About
**anywidget** is both a [**specification**](https://anywidget.dev/en/afm) and
**toolkit** for authoring reusable web-based widgets for interactive computing
environments.
- 🛠️ create custom Jupyter 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**, [**marimo**](https://github.com/marimo-team/marimo) and more
- ⚡ develop with **instant HMR**, like modern web frameworks
Learn more in the
[Jupyter blog](https://blog.jupyter.org/anywidget-jupyter-widgets-made-easy-164eb2eae102).
## Installation
**anywidget** is available on [PyPI](https://pypi.org/project/anywidget/):
```bash
pip install "anywidget[dev]"
```
and also on [conda-forge](https://anaconda.org/conda-forge/anywidget):
```bash
conda install -c conda-forge anywidget
```
## Usage
The easiest way to start developing with **anywidget** is with the Python package.
```python
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):
```python
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](https://anywidget.dev/en/getting-started) to learn
more.
## Packages
Beyond the primary Python package, **anywidget** provides an ecosystem of
tooling to help you build and distribute custom widgets.
| Name | Description | Version (click for changelogs) |
| ------------------------------------------------------------------------------------------------ | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`anywidget`](https://github.com/manzt/anywidget/tree/main/packages/anywidget) | Primary Python package | [](https://github.com/manzt/anywidget/blob/main/packages/anywidget/CHANGELOG.md) |
| [`npm:@anywidget/types`](https://github.com/manzt/anywidget/tree/main/packages/types) | Client type declarations | [](https://github.com/manzt/anywidget/blob/main/packages/types/CHANGELOG.md) |
| [`npm:@anywidget/vite`](https://github.com/manzt/anywidget/tree/main/packages/vite) | Vite plugin | [](https://github.com/manzt/anywidget/blob/main/packages/vite/CHANGELOG.md) |
| [`npm:@anywidget/react`](https://github.com/manzt/anywidget/tree/main/packages/react) | React framework bridge | [](https://github.com/manzt/anywidget/blob/main/packages/react/CHANGELOG.md) |
| [`npm:@anywidget/svelte`](https://github.com/manzt/anywidget/tree/main/packages/svelte) | Svelte framework bridge | [](https://github.com/manzt/anywidget/blob/main/packages/svelte/CHANGELOG.md) |
| [`npm:create-anywidget`](https://github.com/manzt/anywidget/tree/main/packages/create-anywidget) | CLI to bootstrap a new project | [](https://github.com/manzt/anywidget/blob/main/packages/create-anywidget/CHANGELOG.md) |
| [`jsr:@anywidget/deno`](https://github.com/manzt/anywidget/tree/main/packages/deno) | Backend for Deno Jupyter kernel | [](https://github.com/manzt/anywidget/blob/main/packages/deno/CHANGELOG.md) |
| [`jsr:@anywidget/signals`](https://github.com/manzt/anywidget/tree/main/packages/signals) | Signals bridge | [](https://github.com/manzt/anywidget/blob/main/packages/signals/CHANGELOG.md) |
## Support
Having trouble? Get help in our [Discord](https://discord.gg/W5h4vPMbDQ) or open
a [Discussion](https://github.com/manzt/anywidget/issues/new).
## Contributing
**New contributors welcome!** Check out our
[Contributors Guide](./CONTRIBUTING.md) for help getting started.
Join us on [Discord](https://discord.gg/W5h4vPMbDQ) to meet other maintainers.
We'll help you get your first contribution in no time!
## Citation
If you use **anywidget** in your work, please consider citing the following
publications:
Our [JOSS paper](https://joss.theoj.org/papers/10.21105/joss.06939) describing
the overall project and vision:
```bibtex
@article{manz2024anywidget,
title = {anywidget: reusable widgets for interactive analysis and visualization in computational notebooks},
volume = {9},
url = {https://doi.org/10.21105/joss.06939},
doi = {10.21105/joss.06939},
number = {102},
journal = {Journal of Open Source Software},
author = {Manz, Trevor and Abdennur, Nezar and Gehlenborg, Nils},
year = {2024},
note = {Publisher: The Open Journal},
pages = {6939},
}
```
Our [SciPy paper](https://proceedings.scipy.org/articles/NRPV2311), detailing
the motivation and approach behind Jupyter Widget ecosystem compatability:
```bibtex
@inproceedings{manz2024notebooks,
title = {Any notebook served: authoring and sharing reusable interactive widgets},
copyright = {https://creativecommons.org/licenses/by/4.0/},
url = {https://doi.curvenote.com/10.25080/NRPV2311},
doi = {10.25080/NRPV2311},
urldate = {2024-10-07},
booktitle = {Proceedings of the 23rd {Python} in {Science} {Conference}},
author = {Manz, Trevor and Gehlenborg, Nils and Abdennur, Nezar},
month = jul,
year = {2024},
}
```