Control your mouse with your keyboard through KeyFlare
Project description
KeyFlare
About
Some users prefer using a keyboard over a mouse because of accessibility needs or personal reasons. KeyFlare enables users to interactively control their mouse using their keyboard. Showcases available on my website. KeyFlare is open source, free, and both easy to understand and install.
Installation
Suggested:
pip install keyflare
keyflare
Alternative 1:
pip install -e git+https://github.com/Pshah2023/keyflare.git@main#egg=keyflare --upgrade
- The
@main
installs the main branch. - The
#egg=keyflare
makes sure to name the package keyflare - The
--upgrade
forces an update to the library if you had it installed already somehow through another package that depends on it or something else. - The
-e
means that the source code is installed too. The logging done when you run this line (normally the second line from the top) will show you where it is. You can then edit this source code for changes to propagate to the library. I do not often use this feature, but it is there for others if you want it.
Alternative 2:
- Use
git clone https://github.com/Pshah2023/keyflare.git
to install the source code - Optional: create a virtual environment with
python -m venv env
and activate it as per your system - Install dependencies:
pip install -r requirements.txt
- Go to the KeyFlare root directory and run
python keyflare
, which will run the code in__main__.py
automatically.
Inspiration
Vimium C, a common tool for users with accessibility needs for navigating web browsers, does not work on web browsers. Apple Voice Control's smart grid, a tool for navigating on Apple displays, does not work outside of an iPhone and would not be effective on large displays. There was no tool available for this, so I decided to make it.
Features
- Intuitive Hotkey: (Left Alt) + (Lowercase A)
- Intuitive Process: KeyFlare simply opens up a fullscreen image to show you the options on the screen.
- Enhanced image segmentation algorithm that optimizes speed.
- Cross-platform compatibility with Linux, macOS, and Windows. (Untested on macOS since I do not have access to that environment at the moment.)
In the works
- Specifying the number of clicks desired through preferences.
- Making it easier to use KeyFlare through imports by improving the documentation.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file keyflare-1.1.2.tar.gz
.
File metadata
- Download URL: keyflare-1.1.2.tar.gz
- Upload date:
- Size: 12.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2f575cb4aea9b035bfd2afcba6eeebcc73d5d123841d878ccec6a60deb9df2e |
|
MD5 | 650e08d7ece88b9c55b688ae6d8fef99 |
|
BLAKE2b-256 | a34058f8cd1581eeba587e587da0e43a55d21abbb6e4cabb05b96c5553c769d0 |
File details
Details for the file keyflare-1.1.2-py3-none-any.whl
.
File metadata
- Download URL: keyflare-1.1.2-py3-none-any.whl
- Upload date:
- Size: 13.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6df1e9a4fc6dba858a6e2568b5a82005a41eb5795ce72d42e54857fbed9a4911 |
|
MD5 | 02804b1cbc4e7aab8986f75501371742 |
|
BLAKE2b-256 | 4cf25c03229fef7e75130c5c1154ab83e70b42e4c36f758e6383ee41f41f5d39 |