README - Welcome to key_stroke

key_stroke is the python key stroke module for all platforms. It can be used to easily interrupt a running loop by pressing a user defined key or key combination. It comes with a simple and intuitive API and can be used on Linux, Mac as well Windows Systems.

Installation

For a simple and painless installation of the key stroke module in your system, please refer to the documentation. You will find what you are looking for under the heading “Installation of the key_stroke module”.

Documentation

For API documentation, usage and examples see files in the “sphinx” directory. The “.rst” files can be read in any text editor or being converted to HTML or PDF using Sphinx. An HTML version is online at https://chriesibaum.github.io/key_stroke/

Module Requirements

xxx (will be installed during the pip install process)

Coding hints

Nix.

How to build the Package

To build the packet, simply run make build and enjoy a café.
To give the documentation a new shine, simply run make doc.

Build Requirements

For details see: https://packaging.python.org/en/latest/tutorials/packaging-projects/

python3
and a ton of packages specified in requirements.txt to install them run: pip install -r requirements.txt -U