{"author":null,"author_email":"Trevor Manz ","bugtrack_url":null,"classifiers":["Framework :: Jupyter","Framework :: Jupyter :: JupyterLab","Framework :: Jupyter :: JupyterLab :: 4","Framework :: Jupyter :: JupyterLab :: Extensions","Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt","License :: OSI Approved :: MIT License","Programming Language :: Python","Programming Language :: Python :: 3"],"description":"

\n
\n $\"anywidget$ \n
anywidget\n

\n\n \n reusable widgets made easy\n \n \n installation .\n docs .\n discord .\n learn\n \n\n

\n\n## About\n\n**anywidget** is both a [**specification**](https://anywidget.dev/en/afm) and\n**toolkit** for authoring reusable web-based widgets for interactive computing\nenvironments.\n\n- 🛠️ create custom Jupyter Widgets **without complicated cookiecutter templates**\n- 📚 **publish to PyPI** like any other Python package\n- 🤖 prototype **within** `.ipynb` or `.py` files\n- 🚀 run in **Jupyter**, **JupyterLab**, **Google Colab**, **VSCode**, [**marimo**](https://github.com/marimo-team/marimo) and more\n- ⚡ develop with **instant HMR**, like modern web frameworks\n\nLearn more in the\n[Jupyter blog](https://blog.jupyter.org/anywidget-jupyter-widgets-made-easy-164eb2eae102).\n\n## Installation\n\n**anywidget** is available on [PyPI](https://pypi.org/project/anywidget/):\n\n```bash\npip install \"anywidget[dev]\"\n```\n\nand also on [conda-forge](https://anaconda.org/conda-forge/anywidget):\n\n```bash\nconda install -c conda-forge anywidget\n```\n\n## Usage\n\nThe easiest way to start developing with **anywidget** is with the Python package.\n\n```python\nimport anywidget\nimport traitlets\n\nclass CounterWidget(anywidget.AnyWidget):\n # Widget front-end JavaScript code\n _esm = \"\"\"\n function render({ model, el }) {\n let button = document.createElement(\"button\");\n button.innerHTML = `count is ${model.get(\"value\")}`;\n button.addEventListener(\"click\", () => {\n model.set(\"value\", model.get(\"value\") + 1);\n model.save_changes();\n });\n model.on(\"change:value\", () => {\n button.innerHTML = `count is ${model.get(\"value\")}`;\n });\n el.appendChild(button);\n }\n export default { render };\n \"\"\"\n # Stateful property that can be accessed by JavaScript & Python\n value = traitlets.Int(0).tag(sync=True)\n```\n\nFront-end code can also live in separate files (recommend):\n\n```python\nimport pathlib\nimport anywidget\nimport traitlets\n\nclass CounterWidget(anywidget.AnyWidget):\n _esm = pathlib.Path(\"index.js\")\n _css = pathlib.Path(\"styles.css\")\n value = traitlets.Int(0).tag(sync=True)\n```\n\nRead [the documentation](https://anywidget.dev/en/getting-started) to learn\nmore.\n\n## Packages\n\nBeyond the primary Python package, **anywidget** provides an ecosystem of\ntooling to help you build and distribute custom widgets.\n\n| Name | Description | Version (click for changelogs) |\n| ------------------------------------------------------------------------------------------------ | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [`anywidget`](https://github.com/manzt/anywidget/tree/main/packages/anywidget) | Primary Python package | [![version](https://img.shields.io/pypi/v/anywidget.svg?labelColor=0273B7&color=0C3141)](https://github.com/manzt/anywidget/blob/main/packages/anywidget/CHANGELOG.md) |\n| [`npm:@anywidget/types`](https://github.com/manzt/anywidget/tree/main/packages/types) | Client type declarations | [![version](https://img.shields.io/npm/v/@anywidget/types.svg?labelColor=C43636&color=0C3141&logo=npm&label)](https://github.com/manzt/anywidget/blob/main/packages/types/CHANGELOG.md) |\n| [`npm:@anywidget/vite`](https://github.com/manzt/anywidget/tree/main/packages/vite) | Vite plugin | [![version](https://img.shields.io/npm/v/@anywidget/vite.svg?labelColor=C43636&color=0C3141&logo=npm&label)](https://github.com/manzt/anywidget/blob/main/packages/vite/CHANGELOG.md) |\n| [`npm:@anywidget/react`](https://github.com/manzt/anywidget/tree/main/packages/react) | React framework bridge | [![version](https://img.shields.io/npm/v/@anywidget/react.svg?labelColor=C43636&color=0C3141&logo=npm&label)](https://github.com/manzt/anywidget/blob/main/packages/react/CHANGELOG.md) |\n| [`npm:@anywidget/svelte`](https://github.com/manzt/anywidget/tree/main/packages/svelte) | Svelte framework bridge | [![version](https://img.shields.io/npm/v/@anywidget/svelte.svg?labelColor=C43636&color=0C3141&logo=npm&label)](https://github.com/manzt/anywidget/blob/main/packages/svelte/CHANGELOG.md) |\n| [`npm:create-anywidget`](https://github.com/manzt/anywidget/tree/main/packages/create-anywidget) | CLI to bootstrap a new project | [![version](https://img.shields.io/npm/v/create-anywidget.svg?labelColor=C43636&color=0C3141&logo=npm&label)](https://github.com/manzt/anywidget/blob/main/packages/create-anywidget/CHANGELOG.md) |\n| [`jsr:@anywidget/deno`](https://github.com/manzt/anywidget/tree/main/packages/deno) | Backend for Deno Jupyter kernel | [![version](https://jsr.io/badges/@anywidget/deno)](https://github.com/manzt/anywidget/blob/main/packages/deno/CHANGELOG.md) |\n| [`jsr:@anywidget/signals`](https://github.com/manzt/anywidget/tree/main/packages/signals) | Signals bridge | [![version](https://jsr.io/badges/@anywidget/signals)](https://github.com/manzt/anywidget/blob/main/packages/signals/CHANGELOG.md) |\n\n## Support\n\nHaving trouble? Get help in our [Discord](https://discord.gg/W5h4vPMbDQ) or open\na [Discussion](https://github.com/manzt/anywidget/issues/new).\n\n## Contributing\n\n**New contributors welcome!** Check out our\n[Contributors Guide](./CONTRIBUTING.md) for help getting started.\n\nJoin us on [Discord](https://discord.gg/W5h4vPMbDQ) to meet other maintainers.\nWe'll help you get your first contribution in no time!\n\n## Citation\n\nIf you use **anywidget** in your work, please consider citing the following\npublications:\n\nOur [JOSS paper](https://joss.theoj.org/papers/10.21105/joss.06939) describing\nthe overall project and vision:\n\n```bibtex\n@article{manz2024anywidget,\n title = {anywidget: reusable widgets for interactive analysis and visualization in computational notebooks},\n volume = {9},\n url = {https://doi.org/10.21105/joss.06939},\n doi = {10.21105/joss.06939},\n number = {102},\n journal = {Journal of Open Source Software},\n author = {Manz, Trevor and Abdennur, Nezar and Gehlenborg, Nils},\n year = {2024},\n note = {Publisher: The Open Journal},\n pages = {6939},\n}\n```\n\nOur [SciPy paper](https://proceedings.scipy.org/articles/NRPV2311), detailing\nthe motivation and approach behind Jupyter Widget ecosystem compatability:\n\n```bibtex\n@inproceedings{manz2024notebooks,\n title = {Any notebook served: authoring and sharing reusable interactive widgets},\n copyright = {https://creativecommons.org/licenses/by/4.0/},\n url = {https://doi.org/10.25080/NRPV2311},\n doi = {10.25080/NRPV2311},\n urldate = {2024-10-07},\n booktitle = {Proceedings of the 23rd {Python} in {Science} {Conference}},\n author = {Manz, Trevor and Gehlenborg, Nils and Abdennur, Nezar},\n month = jul,\n year = {2024},\n}\n```\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":null,"license":"MIT","license_expression":null,"license_files":["LICENSE"],"maintainer":null,"maintainer_email":null,"name":"anywidget","package_url":"https://pypi.org/project/anywidget/","platform":null,"project_url":"https://pypi.org/project/anywidget/","project_urls":{"homepage":"https://github.com/manzt/anywidget"},"provides_extra":["dev"],"release_url":"https://pypi.org/project/anywidget/0.9.18/","requires_dist":["ipywidgets>=7.6.0","psygnal>=0.8.1","typing-extensions>=4.2.0","watchfiles>=0.18.0; extra == \"dev\""],"requires_python":">=3.8","summary":"custom jupyter widgets made easy","version":"0.9.18","yanked":false,"yanked_reason":null}

\n\n \n anywidget\n

\n
\n $\"anywidget$ \n
anywidget\n

Dependency	Optional
ipywidgets	false
psygnal	false
typing-extensions	false
watchfiles	true

Package search

anywidget

project_urls

Dependencies

All package metadata

Releases