Skip to main content

Python bindings for libtermkey

Project description


PyPI Release Build Status

pylibtermkey is a set of Python bindings for libtermkey, a library for interpreting terminal input. Other Python bindings are out of date and not easily installable. This project has a few differences:

  • libtermkey is automatically built as part of this project
  • pybind11 is used for easy binding
  • unit tests are included
  • precompiled wheels are built from this repo and available on PyPI


To install from PyPI:

pip install pylibtermkey


A minimal example of obtaining a keystroke and printing the results:

import pylibtermkey_cpp as termkey
tk = termkey.TermKey()

res, key = tk.waitkey()
print(tk.strfkey(key, termkey.TermKeyFormat.VIM)

Note that, by default, termkey will read from stdin causing python terminal to not display typed characters. It is best to use termkey in an pre-written script rather in a REPL setup (as you will not be able to see what you are typing once termkey is active).

For other features, see the tests or the libtermkey man pages.


To build this project:

Building from source requires cmake (pip install cmake).


Unit tests

To run the unit tests:

python test

or use nose:

nosetests python/pylibtermkey


This project is licensed under the MIT license. It uses the pybind11 and libtermkey projects whose licenses can be found in those projects' directories.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pylibtermkey-0.3.1.tar.gz (647.0 kB view hashes)

Uploaded source

Built Distributions

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page