Skip to main content

A cross-platform module for GUI automation for humans. Control the keyboard and mouse from a Python script.

Project description


A cross-platform GUI automation Python module for human beings. Used to programmatically control the mouse & keyboard.

THIS MODULE IS UNDER DEVELOPMENT. It’s usable, but not all of the functions may work on all platforms.

This module seeks to replace PyUserInput, PyKeyboard, PyMouse, pykey, and pyhook. See the roadmap in the documentation.

NOTE - It is a known issue that the keyboard-related functions don’t work on Ubuntu VMs in Virtualbox.

Example Usage

>>> import pyautogui
>>> screenWidth, screenHeight = pyautogui.size()
>>> currentMouseX, currentMouseY = pyautogui.position()
>>> pyautogui.moveTo(100, 150)
>>> pyautogui.moveRel(None, 10)  # move mouse 10 pixels down
>>> pyautogui.doubleClick()
>>> pyautogui.moveTo(500, 500, duration=2, tween=pyautogui.tweens.easeInOutQuad)  # use tweening/easing function to move mouse over 2 seconds.
>>> pyautogui.typewrite('Hello world!', interval=0.25)  # type with quarter-second pause in between each key
>>> pyautogui.keyDown('shift')
>>>'left', 'left', 'left', 'left', 'left', 'left')
>>> pyautogui.keyUp('shift')
>>> pyautogui.hotkey('ctrl', 'c')

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for PyAutoGUI, version 0.9.1
Filename, size File type Python version Upload date Hashes
Filename, size (35.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page