| Name | positionkey JSON |
| Version |
1.1.2
JSON |
| download |
| home_page | |
| Summary | A multi-platform python package for mdapping key strokes to mouse clicks. |
| upload_time | 2024-03-08 07:13:42 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2021 Nitesh Prasad Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
tdac
keyboard shortcut
annotation
labelling
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Position Key: Relax your fingers
PositionKey is a multi-platform python package for mapping key strokes to mouse clicks.
## Installation
### Install with pip
PositionKey is available on PyPI as ```positionkey```.
1. Install PositionKey:
```
pip install positionkey
```
For positionkey for function properly, the dependencies will automatically be installed.
### Local Installation
PositionKey is compatible with Linux and Windows systems. To install a local version:
1. Run installation command from the root directory:
```
pip install .
```
## Why use PositionKey?
## Usage
* Currently, there are four keys mapped: **D, V, L and C** which stands for Dismiss, Verify, Long and Cancel respectively. These four keystrokes can store and hit four positions on the GUI screen.
* Say if we need to alternately click on two buttons on the computer's screen, just map the click to any two of the mentioned keys and hit the keys alternately on the keyboard as per need.
* We can record the pixel positions of keys D, V, L, C via the numeric keys 1, 2, 3, 4 respectively. The current position of the mouse pointer will be recorded whenever the above numeric keys are pressed while the script is running.
* The four (x, y) positions will be stored in a CSV file named 'click_positions.csv' in the current directory for resuming the same positions on succesive runs.
* The four positions defaults to (700, 0) pixel of the screen where 700 is the X-coordinate and 0 is the Y-coordinate.
* There is a partition function which will virtually divide the computer screen into two halves: Left and Right. The script will only run when the mouse pointer is on the left of the partition line(vertical) while won't work if the mouse pointer is on the right side of the partition line(Vertical). The partition line can be recorded by hitting the key "P" on the keyboard.
## Licence
[MIT Licence](https://github.com/niteshctrl/positionkey/blob/main/LICENSE)
Raw data
{
"_id": null,
"home_page": "",
"name": "positionkey",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "tdac,keyboard shortcut,annotation,labelling",
"author": "",
"author_email": "Nitesh Prasad <nitesh1612@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/70/83/67bc13c2b1f0a1677cde94a6d13534fbd38b6eb1030839751b417cbf7490/positionkey-1.1.2.tar.gz",
"platform": null,
"description": "\n\n\n\n# Position Key: Relax your fingers\nPositionKey is a multi-platform python package for mapping key strokes to mouse clicks.\n\n\n## Installation\n\n### Install with pip\nPositionKey is available on PyPI as ```positionkey```. \n1. Install PositionKey:\n```\npip install positionkey\n```\nFor positionkey for function properly, the dependencies will automatically be installed.\n\n### Local Installation\nPositionKey is compatible with Linux and Windows systems. To install a local version:\n\n1. Run installation command from the root directory:\n```\npip install .\n```\n\n\n## Why use PositionKey?\n\n\n## Usage\n* Currently, there are four keys mapped: **D, V, L and C** which stands for Dismiss, Verify, Long and Cancel respectively. These four keystrokes can store and hit four positions on the GUI screen.\n* Say if we need to alternately click on two buttons on the computer's screen, just map the click to any two of the mentioned keys and hit the keys alternately on the keyboard as per need.\n* We can record the pixel positions of keys D, V, L, C via the numeric keys 1, 2, 3, 4 respectively. The current position of the mouse pointer will be recorded whenever the above numeric keys are pressed while the script is running.\n* The four (x, y) positions will be stored in a CSV file named 'click_positions.csv' in the current directory for resuming the same positions on succesive runs.\n* The four positions defaults to (700, 0) pixel of the screen where 700 is the X-coordinate and 0 is the Y-coordinate.\n* There is a partition function which will virtually divide the computer screen into two halves: Left and Right. The script will only run when the mouse pointer is on the left of the partition line(vertical) while won't work if the mouse pointer is on the right side of the partition line(Vertical). The partition line can be recorded by hitting the key \"P\" on the keyboard.\n\n \n## Licence\n[MIT Licence](https://github.com/niteshctrl/positionkey/blob/main/LICENSE)\n\n\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2021 Nitesh Prasad Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A multi-platform python package for mdapping key strokes to mouse clicks.",
"version": "1.1.2",
"project_urls": {
"Documentation": "https://github.com/niteshctrl/positionkey/blob/main/README.md",
"Issues": "https://github.com/niteshctrl/positionkey/issues",
"Repository": "https://github.com/niteshctrl/positionkey/"
},
"split_keywords": [
"tdac",
"keyboard shortcut",
"annotation",
"labelling"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "82678c5703c1a4da7306f3b92c1dba8baa81aa2c7738e5a30ee437546f3bfc58",
"md5": "3f8aef62635ec8a70bdd978e6d5b600e",
"sha256": "1b5d583f01c917319940d58589c9c12558edf2a529cfa53af9ddd6ed4fc388a3"
},
"downloads": -1,
"filename": "positionkey-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3f8aef62635ec8a70bdd978e6d5b600e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5389,
"upload_time": "2024-03-08T07:13:41",
"upload_time_iso_8601": "2024-03-08T07:13:41.730960Z",
"url": "https://files.pythonhosted.org/packages/82/67/8c5703c1a4da7306f3b92c1dba8baa81aa2c7738e5a30ee437546f3bfc58/positionkey-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "708367bc13c2b1f0a1677cde94a6d13534fbd38b6eb1030839751b417cbf7490",
"md5": "b7757a9f38f98045453b0da269102fde",
"sha256": "b60eadc0d6b946c4139b29e7e550f1d9f81d6e8f9e139bcb000e2c2d99c56fe7"
},
"downloads": -1,
"filename": "positionkey-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "b7757a9f38f98045453b0da269102fde",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6046,
"upload_time": "2024-03-08T07:13:42",
"upload_time_iso_8601": "2024-03-08T07:13:42.773164Z",
"url": "https://files.pythonhosted.org/packages/70/83/67bc13c2b1f0a1677cde94a6d13534fbd38b6eb1030839751b417cbf7490/positionkey-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-08 07:13:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "niteshctrl",
"github_project": "positionkey",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "positionkey"
}
