Skip to main content

Hook and simulate keyboard events on Windows and Linux

Project description

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 sends 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).

This program makes no attempt to hide itself, so don’t use it for keyloggers.

Usage

Install the PyPI package:

$ sudo pip install keyboard

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

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

Then check the API docs 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.')

# 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.
keyboard.wait()

Known limitations:

  • Events generated under Windows don’t report device id (event.device == None). #21

  • Linux doesn’t seem to report media keys. #20

  • Currently no way to suppress keys (‘catch’ events and block them). #22

  • To avoid depending on X the Linux parts reads raw device files (/dev/input/input*) but this requries 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.

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

keyboard-0.11.0.zip (48.7 kB view details)

Uploaded Source

Built Distributions

keyboard-0.11.0.win-amd64.exe (637.0 kB view details)

Uploaded Source

keyboard-0.11.0-py2.py3-none-any.whl (48.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file keyboard-0.11.0.zip.

File metadata

  • Download URL: keyboard-0.11.0.zip
  • Upload date:
  • Size: 48.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for keyboard-0.11.0.zip
Algorithm Hash digest
SHA256 f9f2251dc76daa44bffc2568ad72eb807276393302ed4ccf2f35e7f393c81759
MD5 7383a628ab5a41c8643aa94133d6d0e9
BLAKE2b-256 c3a17bee30a56a7aa56a717ac959e64dd85030fedeb240425643cd480ae823d2

See more details on using hashes here.

File details

Details for the file keyboard-0.11.0.win-amd64.exe.

File metadata

File hashes

Hashes for keyboard-0.11.0.win-amd64.exe
Algorithm Hash digest
SHA256 f7e756dfc6cef083720c47de814356d3919b8193d4372bef0d32f44ce6f8c4fc
MD5 c8acb7aa01b6c31bd461e1e4e5d64627
BLAKE2b-256 914f203cc98c3617b2ecd4eeeb8f86446be7e1b0f4ae493da1ebc62db8b75de9

See more details on using hashes here.

File details

Details for the file keyboard-0.11.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for keyboard-0.11.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d67dd0c8aa1feb7cad7a7efac6301889d2a99974979d997c7ff29c87d73cfa24
MD5 9c4ff245ca22191278ba671778898059
BLAKE2b-256 73ef523b46398ce06577d7d65b869c6a151d7cc2ecde46082262caf43eb20ccd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page