summaryrefslogtreecommitdiff
path: root/README
blob: 0e74ee412efaf5a66f52d7f49dcbf66011069e48 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
Keyboard-python is a simple module for parsing keyboard input.
It is useful because it can tell you keypresses without the need
for the Enter key to be pressed and can parse the following:

F-keys
Home
End
PageUp
PageDown
Tab
Insert
Delete
Escape
Alt modified keys
Ctrl modified keys

Example:

    from keyboardpython import key, getkey

    alt_A = key.Key('A',key.ALT)
    alt_a = key.Key('a',key.ALT)

    k = getkey()

    if k == alt_A:
        print "You pressed Alt+A!"
    elif k == alt_a:
        print "You pressed Alt+a!"
    elif k.has_modifier(key.ALT):
        print "You pressed Alt but not A"
    elif k.name in 'aA':
        print "You pressed a but not Alt"
    else:
        print "You didn't press Alt or A :("

PLEASE NOTE: The parser was written experimentally, it works on
my machine but that is not to say that it will fully work for
anybody else. If you encounter problems please email me at

snowy[dot]the[dot]crow[at]gmail[dot]com