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 buildand 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
1 maintainer
Metadata
1 maintainer
Release files for key-stroke 1.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| key_stroke-1.3.1.tar.gz | 7.6 MB | Without provenance | Details for key_stroke-1.3.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| key_stroke-1.3.1-py3-none-any.whl | Python 3 | none | any | Details for key_stroke-1.3.1-py3-none-any.whl |
Total release size: 7.6 MB
Release files / key_stroke-1.3.1.tar.gz
| Download URL | key_stroke-1.3.1.tar.gz |
|---|---|
| Size | 7.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8986ed1edb64fc6c601657e1e649957946315b93948b4009b7946b31ce08aa32
|
|
BLAKE2b-256 checksum How to use checksums |
46c6961aa914c015c328939ab7e46cc57d651c40a1b3597db950a7287db8be30
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.3
|
Release files / key_stroke-1.3.1-py3-none-any.whl
| Download URL | key_stroke-1.3.1-py3-none-any.whl |
|---|---|
| Size | 3.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cbab78ace940b6e29fc036955bb0552951cd5c180ee71637906c98091da6cecd
|
|
BLAKE2b-256 checksum How to use checksums |
d9641f449ee8f1f8193c302402d4aba574ccfd4410eb90854509bf4aa97865b9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.3
|
Security for key-stroke 1.3.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
