Metadata-Version: 2.1
Name: termkeymonitor
Version: 1.4.1
Summary: Display pressed keys in the terminal
Home-page: https://gitlab.com/nobodyinperson/termkeymonitor
Author: Yann Buechau
Author-email: nobodyinperson@posteo.de
License: GPLv3
Keywords: cli
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: textual

# ⌨️  Terminal Key Monitor 📟

Show pressed keys in the terminal. Useful e.g. when recording [asciinema screencasts](https://asciinema.org).

`termkeymonitor` connects directly to a local input device using `evdev`.

# 📥 Installation

```bash
# from PyPI
pip install termkeymonitor
# directly from GitLab
pip install git+https://gitlab.com/nobodyinperson/termkeymonitor.git
```

# ❓ Usage

```bash
# use any of the below commands to invoke
termkeymonitor
python -m termkeymonitor
python3 -m termkeymonitor
```

## 🎥 Screencast

[![asciicast](https://asciinema.org/a/543365.svg)](https://asciinema.org/a/543365)

## ⚠️i Caveats

- no Windows support (I guess... `evdev` only works on Unix-likes AFAIK)
- needs a local keyboard connected so doesn't work as expected on remote machines (e.g. via SSH)
- Make sure you have permissions to access the `/dev/input/event*` files (this normally means you need to add yourself to the `input` group)
