keyboard

Take full control of your keyboard with this small Python library. Hook global events, register hotkeys, simulate key presses and much more.

Features

Global event hook on all keyboards (captures keys regardless of focus).
Listen and send keyboard events.
Works with Windows and Linux (requires sudo), with experimental OS X support (thanks @glitchassassin!).
Pure Python, no C modules to be compiled.
Zero dependencies. Trivial to install and deploy, just copy the files.
Python 2 and 3.
Complex hotkey support (e.g. ctrl+shift+m, ctrl+space) with controllable timeout.
Includes high level API (e.g. record and play, add_abbreviation).
Maps keys as they actually are in your layout, with full internationalization support (e.g. Ctrl+ç).
Events automatically captured in separate thread, doesn't block main program.
Tested and documented.
Doesn't break accented dead keys (I'm looking at you, pyHook).
Mouse support available via project mouse (pip install mouse).

Usage

Install the PyPI package:

pip install keyboard

or clone the repository (no installation required, source files are sufficient):

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

or download and extract the zip into your project folder.

Then check the API docs below to see what features are available.

Example

import keyboard

keyboard.press_and_release('shift+s, space')

keyboard.write('The quick brown fox jumps over the lazy dog.')

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

# Press PAGE UP then PAGE DOWN to type "foobar".
keyboard.add_hotkey('page up, page down', lambda: keyboard.write('foobar'))

# Blocks until you press esc.
keyboard.wait('esc')

# Record events until 'esc' is pressed.
recorded = keyboard.record(until='esc')
# Then replay back at three times the speed.
keyboard.play(recorded, speed_factor=3)

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

# Block forever, like `while True`.
keyboard.wait()

Known limitations:

Events generated under Windows don't report device id (event.device == None). #21
Media keys on Linux may appear nameless (scan-code only) or not at all. #20
Key suppression/blocking only available on Windows. #22
To avoid depending on X, the Linux parts reads raw device files (/dev/input/input*) but this requires root.
Other applications, such as some games, may register hooks that swallow all key events. In this case keyboard will be unable to report events.
This program makes no attempt to hide itself, so don't use it for keyloggers or online gaming bots. Be responsible.

Release files for keyboard 0.13.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for keyboard 0.13.5
File	Size	Uploaded
keyboard-0.13.5.zip	71.8 kB	Mar 23, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for keyboard 0.13.5
File	Interpreter	ABI	Platform	Reset
keyboard-0.13.5-py3-none-any.whl 58.1 kB Mar 23, 2020	Python 3	none	any	Details

Total release size: 129.9 kB

Release files / keyboard-0.13.5.zip

Download URL	keyboard-0.13.5.zip
Size	71.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`63ed83305955939ca5c9a73755e5cc43e8242263f5ad5fd3bb7e0b032f3d308b`
BLAKE2b-256 checksum How to use checksums	`7975c969f2258e908c39aadfc57d1cb78247dc49e6d36371bb3a48c194640c01`
Upload date	Mar 23, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.8.0`

Release files / keyboard-0.13.5-py3-none-any.whl

Download URL	keyboard-0.13.5-py3-none-any.whl
Size	58.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`8e9c2422f1217e0bd84489b9ecd361027cc78415828f4fe4f88dd4acd587947b`
BLAKE2b-256 checksum How to use checksums	`5588287159903c5b3fc6d47b651c7ab65a54dcf9c9916de546188a7f62870d6d`
Upload date	Mar 23, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.8.0`