termkeymonitor

Name	termkeymonitor JSON
Version	1.4.5 JSON
	download
home_page	https://gitlab.com/nobodyinperson/termkeymonitor
Summary	Display pressed keys in the terminal
upload_time	2022-12-13 15:04:27
maintainer
docs_url	None
author	Yann Buechau
requires_python	>=3.8
license	GPLv3
keywords	cli
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # ⌨️  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/544131.svg)](https://asciinema.org/a/544131)

## ⚠️ Caveats

- no Windows and MacOS support (Apparently `evdev` only works on Linux... 😔, might need to use some other backend like [`pynput`](https://pypi.org/project/pynput/) in the future)
- 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)

            

Raw data

            {
    "_id": null,
    "home_page": "https://gitlab.com/nobodyinperson/termkeymonitor",
    "name": "termkeymonitor",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "cli",
    "author": "Yann Buechau",
    "author_email": "nobodyinperson@posteo.de",
    "download_url": "https://files.pythonhosted.org/packages/05/e3/0a331f642ce7d5f0b3929ddb2744072c1f5ca43b781654b7ac80fec65a83/termkeymonitor-1.4.5.tar.gz",
    "platform": null,
    "description": "# \u2328\ufe0f  Terminal Key Monitor \ud83d\udcdf\n\nShow pressed keys in the terminal. Useful e.g. when recording [asciinema screencasts](https://asciinema.org).\n\n`termkeymonitor` connects directly to a local input device using `evdev`.\n\n# \ud83d\udce5 Installation\n\n```bash\n# from PyPI\npip install termkeymonitor\n# directly from GitLab\npip install git+https://gitlab.com/nobodyinperson/termkeymonitor.git\n```\n\n# \u2753 Usage\n\n```bash\n# use any of the below commands to invoke\ntermkeymonitor\npython -m termkeymonitor\npython3 -m termkeymonitor\n```\n\n## \ud83c\udfa5 Screencast\n\n[![asciicast](https://asciinema.org/a/544131.svg)](https://asciinema.org/a/544131)\n\n## \u26a0\ufe0f Caveats\n\n- no Windows and MacOS support (Apparently `evdev` only works on Linux... \ud83d\ude14, might need to use some other backend like [`pynput`](https://pypi.org/project/pynput/) in the future)\n- needs a local keyboard connected so doesn't work as expected on remote machines (e.g. via SSH)\n- Make sure you have permissions to access the `/dev/input/event*` files (this normally means you need to add yourself to the `input` group)\n",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "Display pressed keys in the terminal",
    "version": "1.4.5",
    "split_keywords": [
        "cli"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "7d31d1f041944a43824184986196dab6",
                "sha256": "b8db174890adb5d5036e5f2ca4cb3b1c74782803d7e776e7230dea89977f054f"
            },
            "downloads": -1,
            "filename": "termkeymonitor-1.4.5.tar.gz",
            "has_sig": false,
            "md5_digest": "7d31d1f041944a43824184986196dab6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 6307,
            "upload_time": "2022-12-13T15:04:27",
            "upload_time_iso_8601": "2022-12-13T15:04:27.341012Z",
            "url": "https://files.pythonhosted.org/packages/05/e3/0a331f642ce7d5f0b3929ddb2744072c1f5ca43b781654b7ac80fec65a83/termkeymonitor-1.4.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-13 15:04:27",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "gitlab_user": "nobodyinperson",
    "gitlab_project": "termkeymonitor",
    "lcname": "termkeymonitor"
}