mouse
=====
Take full control of your mouse with this small Python library. Hook global events, register hotkeys, simulate mouse movement and clicks, and much more.
_Huge thanks to [Kirill Pavlov](http://kirillpavlov.com/) for donating the package name. If you are looking for the Cheddargetter.com client implementation, [`pip install mouse==0.5.0`](https://pypi.python.org/pypi/mouse/0.5.0)._
## Features
- Global event hook on all mice devices (captures events regardless of focus).
- **Listen** and **sends** mouse events.
- Works with **Windows** and **Linux** (requires sudo).
- **Pure Python**, no C modules to be compiled.
- **Zero dependencies**. Trivial to install and deploy, just copy the files.
- **Python 2 and 3**.
- Includes **high level API** (e.g. [record](#mouse.record) and [play](#mouse.play).
- Events automatically captured in separate thread, doesn't block main program.
- Tested and documented.
This program makes no attempt to hide itself, so don't use it for keyloggers.
## Usage
Install the [PyPI package](https://pypi.python.org/pypi/mouse/):
$ sudo pip install mouse
or clone the repository (no installation required, source files are sufficient):
$ git clone https://github.com/boppreh/mouse
Then check the [API docs](https://github.com/boppreh/mouse#api) to see what features are available.
## Known limitations:
- Events generated under Windows don't report device id (`event.device == None`). [#21](https://github.com/boppreh/keyboard/issues/21)
- To avoid depending on X the Linux parts reads raw device files (`/dev/input/input*`) but this requries root.
- Other applications, such as some games, may register hooks that swallow all key events. In this case `mouse` will be unable to report events.
Raw data
{
"_id": null,
"home_page": "https://github.com/boppreh/mouse",
"name": "mouse",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "mouse hook simulate hotkey",
"author": "BoppreH",
"author_email": "boppreh@gmail.com",
"download_url": "",
"platform": "",
"description": "\nmouse\n=====\n\nTake full control of your mouse with this small Python library. Hook global events, register hotkeys, simulate mouse movement and clicks, and much more.\n\n_Huge thanks to [Kirill Pavlov](http://kirillpavlov.com/) for donating the package name. If you are looking for the Cheddargetter.com client implementation, [`pip install mouse==0.5.0`](https://pypi.python.org/pypi/mouse/0.5.0)._\n\n## Features\n\n- Global event hook on all mice devices (captures events regardless of focus).\n- **Listen** and **sends** mouse events.\n- Works with **Windows** and **Linux** (requires sudo).\n- **Pure Python**, no C modules to be compiled.\n- **Zero dependencies**. Trivial to install and deploy, just copy the files.\n- **Python 2 and 3**.\n- Includes **high level API** (e.g. [record](#mouse.record) and [play](#mouse.play).\n- Events automatically captured in separate thread, doesn't block main program.\n- Tested and documented.\n\nThis program makes no attempt to hide itself, so don't use it for keyloggers.\n\n## Usage\n\nInstall the [PyPI package](https://pypi.python.org/pypi/mouse/):\n\n $ sudo pip install mouse\n\nor clone the repository (no installation required, source files are sufficient):\n\n $ git clone https://github.com/boppreh/mouse\n\nThen check the [API docs](https://github.com/boppreh/mouse#api) to see what features are available.\n\n\n## Known limitations:\n\n- Events generated under Windows don't report device id (`event.device == None`). [#21](https://github.com/boppreh/keyboard/issues/21)\n- To avoid depending on X the Linux parts reads raw device files (`/dev/input/input*`) but this requries root.\n- Other applications, such as some games, may register hooks that swallow all key events. In this case `mouse` will be unable to report events.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Hook and simulate mouse events on Windows and Linux",
"version": "0.7.1",
"project_urls": {
"Homepage": "https://github.com/boppreh/mouse"
},
"split_keywords": [
"mouse",
"hook",
"simulate",
"hotkey"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e5cc4a30b48913a3bdaa3f713a160517792f829a1703257fb0869e76f945a760",
"md5": "c71a5ab0bc833a760e1fdf68b36558fd",
"sha256": "d34bb9548890089fcb11988400e26f55c624e6c7b741fff75fedfdfbd37c0016"
},
"downloads": -1,
"filename": "mouse-0.7.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "c71a5ab0bc833a760e1fdf68b36558fd",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 16170,
"upload_time": "2020-01-01T16:51:33",
"upload_time_iso_8601": "2020-01-01T16:51:33.438923Z",
"url": "https://files.pythonhosted.org/packages/e5/cc/4a30b48913a3bdaa3f713a160517792f829a1703257fb0869e76f945a760/mouse-0.7.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-01-01 16:51:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "boppreh",
"github_project": "mouse",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mouse"
}
JSON
