Skip to main content

A simple, cross-platform module for mouse and keyboard control

Project description


A module for cross-platform control of the mouse and keyboard in python that is
simple to use.

Mouse control should work on Windows, Mac, and X11 (most Linux systems).
Scrolling is implemented, but users should be aware that variations may
exist between platforms and applications.

Keyboard control works on X11(linux) and Windows systems. Mac control is a work
in progress.


Depending on your platform, you will need the following python modules for
PyUserInput to function:

* Linux - Xlib
* Mac - Quartz, AppKit
* Windows - pywin32, pyHook

How to get started

After installing PyUserInput, you should have pymouse and pykeyboard modules in
your python path. Let's make a mouse and keyboard object:

from pymouse import PyMouse
from pykeyboard import PyKeyboard

m = PyMouse()
k = PyKeyboard()

Here's an example of clicking the center of the screen and typing "Hello, World!":

x_dim, y_dim = m.screen_size(), y_dim/2, 1)
k.type_string('Hello, World!')

PyKeyboard supports a wide range of special keys.

#Create an Alt+Tab combo

k.tap_key(k.function_keys[5]) # Tap F5
k.tap_key(k.numpad_keys['Home']) # Tap 'Home' on the numpad
k.tap_key(k.numpad_keys[5], n=3) # Tap 5 on the numpad, thrice

Consistency between platforms is a big challenge; I should create better documentation
for this. Meanwhile, aside from browsing the source, the following tools will go a
long way in showing you what is available:

#If a key value is 0 or None, it's probably not supported on your platform
dir(k) #Use dir() on a PyKeyboard instance

I'd like to make a special note about using PyMouseEvent and PyKeyboardEvent.
These objects are a framework for listening for mouse and keyboard input; they
don't do anything besides listen until you subclass them. I'm still formalizing
PyKeyboardEvent, so here's an example of subclassing PyMouseEvent:

from pymouse import PyMouseEvent

def fibo():
a = 0
yield a
b = 1
yield b
while True:
a, b = b, a+b
yield b

class Clickonacci(PyMouseEvent):
def __init__(self):
self.fibo = fibo()

def click(self, x, y, button, press):
'''Print Fibonacci numbers when the left click is pressed.'''
if button == 1:
if press:
else: # Exit if any other mouse button used

C = Clickonacci()

Intended Functionality of Capturing in PyUserInput

For PyMouseEvent classes, the variables "capture" and "capture_move" may be
passed during instantiation. If `capture=True` is passed, the intended result
is that all mouse button input will go to your program and nowhere else. The
same is true for `capture_move=True` except it deals with mouse pointer motion
instead of the buttons. Both may be set simultaneously, and serve to prevent
events from propagating further. If you notice any bugs with this behavior,
please bring it to our attention.

A Short Todo List

These are a few things I am considering for future development in

* Ensuring that PyMouse capturing works for all platforms
* Implement PyKeyboard capturing (add PyKeyboardEvent for Mac as well)
* PyMouse dynamic delta scrolling (available in Mac and Windows, hard to standardize)
* Make friends with more Mac developers, testing help is needed...

Many thanks to

[Pepijn de Vos]( - For making
[PyMouse]( and allowing me to modify
and distribute it along with PyKeyboard.

[Jack Grigg]( - For contributions to
cross-platform scrolling in PyMouse.

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

PyUserInput-0.1.7.tar.gz (14.6 kB view hashes)

Uploaded source

Supported by

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