keybind

Global key binding made easy


Keywords
hotkeys, keybindings, linux, python, unix, x11
License
BSD-1-Clause
Install
pip install keybind==0.3.0

Documentation

keybind

https://github.com/idlesign/keybind

LBC Python 2

release lic ci coverage

Description

Global key binding made easy

Requires X11 (X Window System). For UNIX-like systems, e.g. Linux.

Can be used both as a Python package and from CLI.

Features:

  • Create some global key bindings to your functions.
  • Use them in your GUI or CLI application.
  • Bind arbitrary program run to a key using CLI.

From Python

from keybind import KeyBinder


def do():
    print('done')

# The following will start key listening loop in a thread
# (useful if you don't want to block your main program).
KeyBinder.activate({

    'Ctrl-K': do,
    'Shift-R': None,  # Do not run anything, just intercept.

}, run_thread=True)

From CLI

; Listen to Ctrl-K, Ctrl-R and D (keycode 40).
; Provide as many -k as you want.
$ keybind -k "Ctrl-K=ls -lah" -k "Ctrl-R=python run.py somearg --someopt" -k "40=date"

; All keys interception mode. Show keycodes.
; Use wisely, keep your mouse ready.
$ keybind --sniff