Skip to content

giswqs/anywidget

Repository files navigation

anywidget logo. A circular icon with two connected arrows pointing clockwise, symbolizing a refresh or restart action
anywidget

custom jupyter widgets made easy

installation . docs . discord . 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.ipynb or .py files
  • 🚀 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

importanywidgetimporttraitletsclassCounterWidget(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 & Pythonvalue=traitlets.Int(0).tag(sync=True)

Front-end code can also live in separate files (recommend):

importpathlibimportanywidgetimporttraitletsclassCounterWidget(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.

NameDescriptionVersion (click for changelogs)
anywidgetPrimary Python packageversion
npm:@anywidget/typesClient type declarationsversion
npm:@anywidget/viteVite pluginversion
npm:@anywidget/reactReact framework bridgeversion
npm:@anywidget/svelteSvelte framework bridgeversion
npm:create-anywidgetCLI to bootstrap a new projectversion
jsr:@anywidget/denoBackend for Deno Jupyter kernelversion
jsr:@anywidget/signalsSignals bridgeversion

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

MIT

About

custom jupyter widgets made easy

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python43.8%
  • JavaScript22.2%
  • TypeScript17.6%
  • TeX16.3%
  • Svelte0.1%