Skip to main content

Control your mouse with your keyboard through KeyFlare

Project description

Build KeyFlare executables

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.

An example image of KeyFlare in action

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.

Please fill out the survey

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

keyflare-1.1.1.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

keyflare-1.1.1-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file keyflare-1.1.1.tar.gz.

File metadata

  • Download URL: keyflare-1.1.1.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for keyflare-1.1.1.tar.gz
Algorithm Hash digest
SHA256 c3c9136cb8ab2782112e5513d4b0177b39d9c8b6fe9c8f263f8076b864e028eb
MD5 f154cfd00e446a0e5e35cfdc02ba4696
BLAKE2b-256 816113d85883f6d383848cc9b320dd40ae126d30f74ee7403e62b8ce84b9dd82

See more details on using hashes here.

File details

Details for the file keyflare-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: keyflare-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for keyflare-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f764278d0e9a545629e30d975a77d33b7674785a58c9407415bfc9009f456d3c
MD5 d6db4ece21d7136c79860ee6ac876e59
BLAKE2b-256 c4ee922008a49d33506c88ae2c6731775b489b2a149c1cbee5a813e99caaa097

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page