keyboard: Python Library for Global Keyboard Event Control

Introduction

The keyboard library by boppreh is a versatile Python tool that provides full control over global keyboard events. It allows developers to hook into keyboard events, register custom hotkeys, and simulate key presses on Windows, Linux, and experimentally on macOS. While the project is currently unmaintained, it offers a robust set of features for many applications requiring direct interaction with the keyboard.

Installation

Getting started with keyboard is straightforward. You can install it via pip or by cloning the repository directly.

To install using pip:

pip install keyboard

Alternatively, you can clone the GitHub repository, as no installation is required; the source files are sufficient:

git clone https://github.com/boppreh/keyboard

Examples

The keyboard library offers a high-level API for various keyboard interactions. Here are a few examples to illustrate its capabilities:

Simulating Key Presses and Typing:

import keyboard

# Press and release a hotkey combination
keyboard.press_and_release('shift+s, space')

# Type a string of text
keyboard.write('The quick brown fox jumps over the lazy dog.')

Registering Hotkeys:

# Register a hotkey to print a message
keyboard.add_hotkey('ctrl+shift+a', print, args=('triggered', 'hotkey'))

# Register a multi-step hotkey to type text
keyboard.add_hotkey('page up, page down', lambda: keyboard.write('foobar'))

Recording and Playing Events:

# Blocks until 'esc' is pressed, recording all events
recorded = keyboard.record(until='esc')
# Replay the recorded events at three times the speed
keyboard.play(recorded, speed_factor=3)

Creating Abbreviations:

# Type '@@' then press space to replace with an email address
keyboard.add_abbreviation('@@', 'my.long.email@example.com')

Waiting for a Key Press:

# Blocks the program until 'esc' is pressed
keyboard.wait('esc')

Why Use It

The keyboard library stands out for several reasons:

• Global Event Hook: Captures key events regardless of the active window's focus.
• Cross-Platform Support: Works on Windows, Linux (requires sudo), and offers experimental macOS support.
• Pure Python & Zero Dependencies: Easy to install and deploy without complex compilation or external requirements.
• Internationalization: Maps keys according to your actual keyboard layout, supporting international characters like Ctrl+ç.
• Complex Hotkey Support: Allows for intricate hotkey combinations and sequences (e.g., ctrl+shift+m, ctrl+space).
• High-Level API: Includes convenient functions for recording/playing events and adding abbreviations.
• Asynchronous Event Handling: Events are captured in a separate thread, preventing the main program from blocking.

Links

You can find more information, contribute, or report issues by visiting the official repository and PyPI page:

• GitHub Repository
• PyPI Package