https://github.com/cc-d/pyhotkeys
Simple broadly-compatible hotkey program for macos/ubuntu for my own use.
https://github.com/cc-d/pyhotkeys
Last synced: 7 days ago
JSON representation
Simple broadly-compatible hotkey program for macos/ubuntu for my own use.
- Host: GitHub
- URL: https://github.com/cc-d/pyhotkeys
- Owner: cc-d
- License: mit
- Created: 2023-08-30T22:29:54.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-31T00:10:45.000Z (almost 3 years ago)
- Last Synced: 2025-03-02T21:17:31.452Z (over 1 year ago)
- Language: Python
- Size: 8.79 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PyHotkey
A hotkey combination listener that outputs text after keypress combo listener is activated.
## Installation
This was created under the assumption of python version 3.11
To install PyHotkey, run the following command:
```bash
pip install pyhotkey
```
## Usage
To activate the PyHotkey hotkey combination listener, use:
```bash
pyhotkey
```
### Virtual Env
Run `. ./use-venv.sh` to switch to python3.11 using python and activate/create the virtual environment.
## Features
- Activate and deactivate the hotkey combination listener using a PyHotkey modifier key.
- Define your custom hotkey combinations and their corresponding actions in `combos.json`.
## Configuration
Edit `combos.json` to define your hotkey combinations and the text that should be output when each combination is activated.
Example:
```json
{
"ctrl+alt+a": "Text for ctrl+alt+a",
"ctrl+alt+b": "Text for ctrl+alt+b"
}
```
## Tests
To run tests, run the following command:
```bash
python -m unittest tests.py
```
## Contribution
Contributions are welcome! Please read the [contribution guidelines](CONTRIBUTING.md) first.
## License
MIT
## Author
Cary Carter
Email: ccarterdev@gmail.com
GitHub: [cc-d](https://github.com/cc-d)