CatLock

CatLock is a simple utility designed to prevent accidental keyboard input, particularly when your feline friend decides to grace your workspace. Currently only supported on Windows

Features

• Lock your keyboard with a hotkey (Ctrl + L).
• See a semi-transparent overlay indicating the keyboard is locked, allowing uninterrupted viewing.
• Unlock the keyboard by clicking on the overlay.
• Access configuration options via a convenient system tray menu:
  • Adjust overlay opacity to suit your preferences.
  • Enable or disable system notifications when the keyboard is locked.

Code signing policy

Free code signing provided by SignPath.io, certificate by SignPath Foundation.

Team roles

• Committers and reviewers: Project maintainer (https://github.com/richiehowelll)
• Approvers: Project maintainer (https://github.com/richiehowelll)

Privacy policy

This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it.

CatLock does not collect, transmit, or store personal data. Any third-party libraries used by this project operate locally on the user's system.

Build an executable

pip install pyinstaller==6.11.1

pyinstaller --onedir --contents-directory="_internal" --add-data="./resources/img/icon.ico;./resources/img/" --add-data="./resources/img/icon.png;./resources/img/" --add-data="./resources/config/config.json;./resources/config/" --icon="./resources/img/icon.ico" --hidden-import plyer.platforms.win.notification --noconsole --name="CatLock" "./src/main.py"

The release build ships the installer plus a CatLockPortable.zip folder bundle. Keep the full portable folder together; CatLock.exe depends on the adjacent _internal directory.

Run tests

Install the project dependencies first:

pip install -r requirements.txt

Run the unit tests:

python -m unittest discover -s tests

Caveats

• Relies on https://github.com/boppreh/keyboard/ which only has full support for Windows
• OS bound hotkeys take precedence such as ctrl+alt+del (this way you don't get locked out if something goes wrong)

Support

If you found this project helpful or want to support my work, consider buying me a coffee!

Your contributions will help maintain and improve this project. Thank you!

Tested by: