https://github.com/niteshctrl/positionkey
Multi-platform python package for mapping key strokes to mouse clicks.
https://github.com/niteshctrl/positionkey
keyboard-shortcuts python tdac
Last synced: 21 days ago
JSON representation
Multi-platform python package for mapping key strokes to mouse clicks.
- Host: GitHub
- URL: https://github.com/niteshctrl/positionkey
- Owner: niteshctrl
- License: mit
- Created: 2021-11-15T10:39:36.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-08T07:13:06.000Z (over 2 years ago)
- Last Synced: 2025-12-15T03:54:03.858Z (6 months ago)
- Topics: keyboard-shortcuts, python, tdac
- Language: Python
- Homepage: https://pypi.org/project/positionkey/
- Size: 55.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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)