sshkeyboard

library2.3.1pypypi✓ verified 85d ago

sshkeyboard is a small, cross-platform Python library designed for capturing key presses and releases, primarily intended for use within SSH sessions but also functional in local terminal environments. It provides simple callback mechanisms for handling key events, enabling interactive command-line applications. The current version is 2.3.1, with ongoing maintenance for bug fixes and compatibility.

devops http-networking

pip install sshkeyboard

github ↗package ↗

INSTALL

IMPORT

SIG · SSHKEYBOARD

sshkeyboard

devopspythonv2.3.1

Install

1.5s avg

Import

198ms

Disk

16MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v2.3.1 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.910 runs

installs and imports cleanly · install 0.0s · import 0.210s · 17.8MB

glibc

py 3.10–3.910 runs

installs and imports cleanly · install 1.5s · import 0.185s · 18MB

16MB installed

● package 16MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

listen_keyboard

✓ from sshkeyboard import listen_keyboard

This example demonstrates how to set up `sshkeyboard` to listen for key presses and releases for a specified duration (5 seconds). It defines two callback functions, `on_press` and `on_release`, which are invoked when a key event occurs.

from sshkeyboard import listen_keyboard import time def on_press(key): print(f"Key '{key}' pressed") def on_release(key): print(f"Key '{key}' released") print("Listening for 5 seconds... Press any key.") # Listens for key presses and releases for a duration of 5 seconds listen_keyboard(on_press=on_press, on_release=on_release, until='5 seconds') print("Finished listening.")

Debug

Known issues

gotchaThe `until` parameter in `listen_keyboard` relies on the `pynput` library when running `sshkeyboard` locally (not over SSH). If `pynput` is not installed, the `until` condition might not function as expected, or the program might block indefinitely.

fix

If using `until` locally, install `pynput`: `pip install pynput`.

affects: All versions where `until` is used locally.

gotchaCapturing certain special keys (e.g., function keys, Ctrl+C, Alt+combinations) can be inconsistent across different operating systems and terminal emulators. This is due to variations in how key events are transmitted and interpreted.

fix

Test your application in various target environments. Some terminals may require specific settings or remapping to pass through complex key combinations.

affects: All versions

gotchaRunning `sshkeyboard` applications with `sudo` can lead to unexpected behavior, including a complete failure to detect key presses. This often occurs due to privilege separation and differences in how the root environment handles terminal input.

fix

Avoid using `sudo` unless absolutely necessary. If elevated privileges are required for other parts of your script, consider running the key listening component as a non-root user or investigating specific `sudo` configuration for terminal input.

affects: All versions

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'sshkeyboard'

The `sshkeyboard` library has not been installed in the current Python environment.

fix

Install the library using pip: `pip install sshkeyboard`

The `until` condition is not stopping the `listen_keyboard` function when running locally.

When `sshkeyboard` is used outside of an SSH session, the `until` parameter relies on `pynput` for local key detection. `pynput` is likely not installed.

fix

Install the optional dependency `pynput`: `pip install pynput`

Keys are not being detected or unexpected characters are outputted when pressing certain keys (e.g., F1, arrow keys, Ctrl+Shift+C).

This is often an issue with the terminal emulator or operating system, which may intercept or interpret special keys differently before `sshkeyboard` can capture them. It's not always a library bug.

fix

Try using a different terminal emulator (e.g., Alacritty, Kitty, Windows Terminal, xterm). Ensure your terminal settings are not remapping or consuming these key events. In some cases, configuring `stty` or `terminfo` might be necessary, especially for older SSH servers.

Upgrade

Version history

2.3.1latest on PyPI · released Oct 28, 2021

Audit

Dependencies

pynputoptionalRequired for the 'until' parameter functionality when sshkeyboard is used in non-SSH (local) environments.

Agent activity

8 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/ollipal/sshkeyboard ↗

packagehttps://pypi.org/project/sshkeyboard/ ↗