6 Automation with PyAutoGUI.ipynb

{
 "metadata": {
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": 3
  },
  "orig_nbformat": 2
 },
 "nbformat": 4,
 "nbformat_minor": 2,
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# 6. Automation with PyAutoGUI\n",
    "\n",
    "Question: How do we use Python to automate boring stuff?"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Welcome to PyAutoGUI\n",
    "=====================================\n",
    "\n",
    "\n",
    "PyAutoGUI lets your Python scripts control the mouse and keyboard to automate interactions with other applications. The API is designed to be simple. PyAutoGUI works on Windows, macOS, and Linux, and runs on Python 2 and 3.\n",
    "\n",
    "To install with pip, run ``pip install pyautogui``. See the :doc:`install` page for more details.\n",
    "\n",
    "The source code is available on: https://github.com/asweigart/pyautogui\n",
    "\n",
    "PyAutoGUI has several features:\n",
    "\n",
    "* Moving the mouse and clicking in the windows of other applications.\n",
    "* Sending keystrokes to applications (for example, to fill out forms).\n",
    "* Take screenshots, and given an image (for example, of a button or checkbox), and find it on the screen.\n",
    "* Locate an application's window, and move, resize, maximize, minimize, or close it (Windows-only, currently).\n",
    "* Display alert and message boxes.\n",
    "\n",
    "Here's `a YouTube video of a bot automatically playing the game Sushi Go Round <https://www.youtube.com/watch?v=lfk_T6VKhTE>`_. The bot watches the game's application window and searches for images of sushi orders. When it finds one, it clicks the ingredient buttons to make the sushi. It also clicks the phone in the game to order more ingredients as needed. The bot is completely autonomous and can finish all seven days of the game. This is the kind of automation that PyAutoGUI is capable of.\n",
    "\n",
    "Examples\n",
    "========\n",
    "\n",
    ".. code:: python\n",
    "\n",
    "    >>> import pyautogui\n",
    "\n",
    "    >>> screenWidth, screenHeight = pyautogui.size() # Get the size of the primary monitor.\n",
    "    >>> screenWidth, screenHeight\n",
    "    (2560, 1440)\n",
    "\n",
    "    >>> currentMouseX, currentMouseY = pyautogui.position() # Get the XY position of the mouse.\n",
    "    >>> currentMouseX, currentMouseY\n",
    "    (1314, 345)\n",
    "\n",
    "    >>> pyautogui.moveTo(100, 150) # Move the mouse to XY coordinates.\n",
    "\n",
    "    >>> pyautogui.click()          # Click the mouse.\n",
    "    >>> pyautogui.click(100, 200)  # Move the mouse to XY coordinates and click it.\n",
    "    >>> pyautogui.click('button.png') # Find where button.png appears on the screen and click it.\n",
    "\n",
    "    >>> pyautogui.move(400, 0)      # Move the mouse 400 pixels to the right of its current position.\n",
    "    >>> pyautogui.doubleClick()    # Double click the mouse.\n",
    "    >>> pyautogui.moveTo(500, 500, duration=2, tween=pyautogui.easeInOutQuad)  # Use tweening/easing function to move mouse over 2 seconds.\n",
    "\n",
    "    >>> pyautogui.write('Hello world!', interval=0.25)  # type with quarter-second pause in between each key\n",
    "    >>> pyautogui.press('esc')     # Press the Esc key. All key names are in pyautogui.KEY_NAMES\n",
    "\n",
    "    >>> pyautogui.keyDown('shift') # Press the Shift key down and hold it.\n",
    "    >>> pyautogui.press(['left', 'left', 'left', 'left']) # Press the left arrow key 4 times.\n",
    "    >>> pyautogui.keyUp('shift')   # Let go of the Shift key.\n",
    "\n",
    "    >>> pyautogui.hotkey('ctrl', 'c') # Press the Ctrl-C hotkey combination.\n",
    "\n",
    "    >>> pyautogui.alert('This is the message to display.') # Make an alert box appear and pause the program until OK is clicked.\n",
    "\n",
    "This example drags the mouse in a square spiral shape in MS Paint (or any graphics drawing program):\n",
    "\n",
    ".. code:: python\n",
    "\n",
    "    >>> distance = 200\n",
    "    >>> while distance > 0:\n",
    "            pyautogui.drag(distance, 0, duration=0.5)   # move right\n",
    "            distance -= 5\n",
    "            pyautogui.drag(0, distance, duration=0.5)   # move down\n",
    "            pyautogui.drag(-distance, 0, duration=0.5)  # move left\n",
    "            distance -= 5\n",
    "            pyautogui.drag(0, -distance, duration=0.5)  # move up\n",
    "\n",
    ".. image:: square_spiral.png\n",
    "\n",
    "The benefit of using PyAutoGUI, as opposed to a script that directly generates the image file, is that you can use the brush tools that MS Paint provides."
   ]
  }
 ]
}