Skip to main content

A keyboard listener that allows for custom combinations and keywords to trigger custom functions

Project description

keyboard_listener

Keyboard Listener is a module that allows you to create custom hotkeys (combinations) or custom keywords and bind them to custom functions in Python. It's really easy to use and can be installed via pip:

pip install keyboard_listener

Combinations are custom hotkeys that are bound to functions. When the combination is pressed, the function is executed. Combos are really easy to set up and can be seen in the example below.

Keywords are custom strings that when entered (or rather, when their characters are entered in sequence) trigger a function to be executed. Keywords are also shown in the example below.

KeyboardListener object needs to be instantiated with the custom combinations and custom keywords dictionaries before running. Please refer to the below example to see how to set those up. If no dictionaries are passed, the program will assume no combinations or keywords are set up.

Example:

from keyboard_listener import KeyboardListener, Combo, KeyWord

def function_1(arguments):
  # do something

def function_2(arguments):
  # do something else

combinations = {

      'function 1': Combo(['alt'], 'f', function_1, arguments), 
        #Function 1 is executed when the user presses Alt+F
      'function 2': Combo(['ctr','alt'], 'g', function_2, arguments), 
        #Function 2 is executed when the user presses Alt+G
      'function 3': Combo(['shift','alt'], 'H', function_2, arguments), 
        #Be mindful when setting up Combos that include 'shift'. If the Combo includes the shift key, the character must be uppercase.
}

keywords = {

    'keyword_1': KeyWord('keyword1', function_1, arguments), 
      #Function 1 is executed when the user types 'keyword1'
    'keyword_2': KeyWord('keyword1', function_2, arguments) 
      #Function 2 is executed when the user types 'keyword2'
}

keyboard_listener = KeyboardListener(combinations=combinations, keywords=keywords)
keyboard_listener.run()

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-listener-0.0.7.tar.gz (3.4 kB view details)

Uploaded Source

Built Distribution

keyboard_listener-0.0.7-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

Details for the file keyboard-listener-0.0.7.tar.gz.

File metadata

  • Download URL: keyboard-listener-0.0.7.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.3

File hashes

Hashes for keyboard-listener-0.0.7.tar.gz
Algorithm Hash digest
SHA256 849ce710d243cefc98cccea3cd13d41a6e5a7886d9aabd56ab54f99d90437e64
MD5 0698ca2508d55f2adbe98e3943f867c1
BLAKE2b-256 c12c5bc5e3660ad2bc27ee61467116e0867d8af61a4b05e299793d2fbd04a527

See more details on using hashes here.

File details

Details for the file keyboard_listener-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: keyboard_listener-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 16.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.3

File hashes

Hashes for keyboard_listener-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 10bd9e03aaaea6d8173020109f6f4b1833f3d230abb0ea1a47583d6bf1b0129b
MD5 ce3e4cf141d76c80e3e5ca63c94de380
BLAKE2b-256 815788272c461f5c261834cafa5e9275a6648b2433c4458ce22729bf49493e7f

See more details on using hashes here.

Supported by

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