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:
Documentation
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
Release history Release notifications | RSS feed
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.2.tar.gz
(227.3 kB
view details)
Built Distribution
ipyevents-2.0.2-py3-none-any.whl
(101.8 kB
view details)
File details
Details for the file ipyevents-2.0.2.tar.gz
.
File metadata
- Download URL: ipyevents-2.0.2.tar.gz
- Upload date:
- Size: 227.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26e878b0c5854bc8b6bd6a2bd2c89b314ebe86fda642f4d2434051545bab258f |
|
MD5 | 8e0b10102b66f7df6d1cb7b95f1523b4 |
|
BLAKE2b-256 | 85d8254c3d2ed96b2c562d3a0365909a20a5faa40c5d55ca2b403cdf008a9c90 |
File details
Details for the file ipyevents-2.0.2-py3-none-any.whl
.
File metadata
- Download URL: ipyevents-2.0.2-py3-none-any.whl
- Upload date:
- Size: 101.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60c2a9e992bdc41e8577aa27e57b124efafa48a59a3bff886029fe5700d546b3 |
|
MD5 | e84dfb76841b93cfb47a87da017e1443 |
|
BLAKE2b-256 | af495692d363a82838282f5c33a787922f07115d7ba4b452391e51db95c9d247 |