Skip to main content

A custom widget for returning mouse and keyboard events to Python

Project description

ipyevents

Browsers events for your jupyter widgets

ipyevents provides a custom widget for returning mouse and keyboard events to Python. Use it to:

  • add keyboard shortcuts to an existing widget;
  • react to the user clicking on an image;
  • add callbacks on arbitrary mouse and keyboard events.

See this demo notebook for documentation.

Special thanks to the contributors to ipyevents!

Try it on binder:

Dev version: Binder

Documentation

Documentation Status

Installation

To install using conda:

$ conda install -c conda-forge ipyevents

To install use pip:

$ pip install ipyevents

Using with JupyterLab (whether you installed with conda or pip):

  • The stable releases of ipyevents (2.0.0 and higher) are only built for JupyterLab 3 and up.
  • The last release that is built for JupyterLab 2 is 0.9.0. See the README for that version for installation instructions.
$ jupyter labextension install @jupyter-widgets/jupyterlab-manager ipyevents

For a development installation (requires npm),

$ git clone https://github.com/mwcraig/ipyevents.git
$ cd ipyevents
$ pip install -e .
$ jupyter nbextension install --py --symlink --sys-prefix ipyevents
$ jupyter nbextension enable --py --sys-prefix ipyevents

For Jupyter Lab also do this:

$ npm install
$ npm run build
$ jupyter labextension install

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ipyevents-2.0.4.tar.gz (210.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ipyevents-2.0.4-py3-none-any.whl (102.4 kB view details)

Uploaded Python 3

File details

Details for the file ipyevents-2.0.4.tar.gz.

File metadata

  • Download URL: ipyevents-2.0.4.tar.gz
  • Upload date:
  • Size: 210.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.8

File hashes

Hashes for ipyevents-2.0.4.tar.gz
Algorithm Hash digest
SHA256 bd8c66a9ff26f481494cda1ec1d979722ca9eba19f8ef52538c7cc2db2a1a139
MD5 bd384947cc46eba48b1d23f2daad6b07
BLAKE2b-256 82e5ac7e199dd22ce3f7e0d43c6433fef5450197fa81994393e3381893b12d61

See more details on using hashes here.

File details

Details for the file ipyevents-2.0.4-py3-none-any.whl.

File metadata

  • Download URL: ipyevents-2.0.4-py3-none-any.whl
  • Upload date:
  • Size: 102.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.8

File hashes

Hashes for ipyevents-2.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e532e05b037f70373850723f483d2830cb8a633e5aa19637ee9e7adaf41421f1
MD5 aef3b51210b0bce58c12fc667b1e7b48
BLAKE2b-256 cad3642a6dc3db8ea558a9b5fbc83815b197861868dc98f98a789b85c7660670

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page