getchlib 1.1.3

Library for reading key presses

getchlib - library for reading key presses

Overview

getchlib is library for reading key presses and assigning hotkeys.

Features

1. Full Unicode support
2. Blocking and non-blocking key press reading
3. Cross-platform support
4. Basic hotkeys ( CTRL-V or ALT-A ) are defined
5. Not interruptable key press reading support ( cannot be interrupted by CTRL-C, returns key code instead )
6. Keys like arrow up, arrow left, arrow down, arrow right are defined (for full list, view getchlib.keynames.raw)

Installation

pip install getchlib

Usage

Key Presses

Blocking

import getchlib
key=getchlib.getkey()

Waits until user presses a key.

Non-Blocking

import getchlib
key=getchlib.getkey(False)

Returns first key pressed in time specified by its second argument tout ( 0.01 by default ).

Not interruptable

import getchlib
key=getchlib.getkey(catch=True)

Echo argument (new in v1.0.3)

With echo=True characters readed are echoed to the screen.

key=getchlib.getkey(echo=True)

Hotkeys

import getchlib
def function():
	print('hello')
f=getchlib.HotKeyListener()
f.add_hotkey('ctrl-x',function)
f.start()

Not interruptable

import getchlib
def function():
	print('hello')
f=getchlib.HotKeyListener(catch=True)
f.add_hotkey('a',function)
f.start()

Non-blocking (linux only)

import getchlib
def function():
	print('hello')
f=getchlib.HotKeyListener(catch=True)
f.add_hotkey('a',function)
...
f.terminate()

License

getchlib is licensed under GPL License