| Name | ipyevents JSON |
| Version |
2.0.2
JSON |
| download |
| home_page | |
| Summary | A custom widget for returning mouse and keyboard events to Python |
| upload_time | 2023-08-21 03:37:00 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | BSD 3-clause |
| keywords |
ipython
jupyter
widgets
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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](docs/events.ipynb) for documentation.
Special thanks to the [contributors to `ipyevents`](CONTRIBUTORS.md)!
## Try it on binder:
Dev version:
[](https://mybinder.org/v2/gh/mwcraig/ipyevents/HEAD?filepath=docs%2Fevents.ipynb)
## Documentation
[](https://ipyevents.readthedocs.io/en/latest/?badge=latest)
## Installation
To install using `conda`:
```bash
$ 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](https://github.com/mwcraig/ipyevents/tree/0.9.0) for installation instructions.
```bash
$ jupyter labextension install @jupyter-widgets/jupyterlab-manager ipyevents
```
### For a development installation (requires npm),
```bash
$ 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:
```bash
$ npm install
$ npm run build
$ jupyter labextension install
```
Raw data
{
"_id": null,
"home_page": "",
"name": "ipyevents",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "IPython,Jupyter,Widgets",
"author": "",
"author_email": "Matt Craig <mattwcraig@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/85/d8/254c3d2ed96b2c562d3a0365909a20a5faa40c5d55ca2b403cdf008a9c90/ipyevents-2.0.2.tar.gz",
"platform": null,
"description": "# ipyevents\n\n## Browsers events for your jupyter widgets\n\n*ipyevents* provides a custom widget for returning mouse and keyboard events to\nPython. Use it to:\n\n - add keyboard shortcuts to an existing widget;\n - react to the user clicking on an image;\n - add callbacks on arbitrary mouse and keyboard events.\n\nSee [this demo notebook](docs/events.ipynb) for documentation.\n\nSpecial thanks to the [contributors to `ipyevents`](CONTRIBUTORS.md)!\n\n## Try it on binder:\n\nDev version:\n[](https://mybinder.org/v2/gh/mwcraig/ipyevents/HEAD?filepath=docs%2Fevents.ipynb)\n\n## Documentation\n\n[](https://ipyevents.readthedocs.io/en/latest/?badge=latest)\n\n\n## Installation\n\n\nTo install using `conda`:\n\n```bash\n$ conda install -c conda-forge ipyevents\n```\n\nTo install use `pip`:\n\n $ pip install ipyevents\n\nUsing with JupyterLab (whether you installed with `conda` or `pip`):\n\n+ The stable releases of ipyevents (`2.0.0` and higher) are only built for JupyterLab 3 and up.\n+ The last release that is built for JupyterLab 2 is 0.9.0. See the [README for that version](https://github.com/mwcraig/ipyevents/tree/0.9.0) for installation instructions.\n\n```bash\n$ jupyter labextension install @jupyter-widgets/jupyterlab-manager ipyevents\n```\n\n### For a development installation (requires npm),\n\n```bash\n$ git clone https://github.com/mwcraig/ipyevents.git\n$ cd ipyevents\n$ pip install -e .\n$ jupyter nbextension install --py --symlink --sys-prefix ipyevents\n$ jupyter nbextension enable --py --sys-prefix ipyevents\n```\n\nFor Jupyter Lab also do this:\n\n```bash\n$ npm install\n$ npm run build\n$ jupyter labextension install\n```\n",
"bugtrack_url": null,
"license": "BSD 3-clause",
"summary": "A custom widget for returning mouse and keyboard events to Python",
"version": "2.0.2",
"project_urls": {
"Homepage": "https://github.com/mwcraig/ipyevents"
},
"split_keywords": [
"ipython",
"jupyter",
"widgets"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "af495692d363a82838282f5c33a787922f07115d7ba4b452391e51db95c9d247",
"md5": "e84dfb76841b93cfb47a87da017e1443",
"sha256": "60c2a9e992bdc41e8577aa27e57b124efafa48a59a3bff886029fe5700d546b3"
},
"downloads": -1,
"filename": "ipyevents-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e84dfb76841b93cfb47a87da017e1443",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 101789,
"upload_time": "2023-08-21T03:36:59",
"upload_time_iso_8601": "2023-08-21T03:36:59.220502Z",
"url": "https://files.pythonhosted.org/packages/af/49/5692d363a82838282f5c33a787922f07115d7ba4b452391e51db95c9d247/ipyevents-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "85d8254c3d2ed96b2c562d3a0365909a20a5faa40c5d55ca2b403cdf008a9c90",
"md5": "8e0b10102b66f7df6d1cb7b95f1523b4",
"sha256": "26e878b0c5854bc8b6bd6a2bd2c89b314ebe86fda642f4d2434051545bab258f"
},
"downloads": -1,
"filename": "ipyevents-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "8e0b10102b66f7df6d1cb7b95f1523b4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 227253,
"upload_time": "2023-08-21T03:37:00",
"upload_time_iso_8601": "2023-08-21T03:37:00.823983Z",
"url": "https://files.pythonhosted.org/packages/85/d8/254c3d2ed96b2c562d3a0365909a20a5faa40c5d55ca2b403cdf008a9c90/ipyevents-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-21 03:37:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mwcraig",
"github_project": "ipyevents",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ipyevents"
}
