Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pywinauto/pywinauto

Windows GUI Automation with Python (based on text properties)
https://github.com/pywinauto/pywinauto

automation gui hooks linux python python-library pywinauto qa testing testing-tools ui-automated-tests ui-automation uiautomation user-interface win32api windows windows-api

Last synced: about 1 month ago
JSON representation

Windows GUI Automation with Python (based on text properties)

Host: GitHub
URL: https://github.com/pywinauto/pywinauto
Owner: pywinauto
License: bsd-3-clause
Created: 2015-05-25T09:50:40.000Z (over 9 years ago)
Default Branch: atspi
Last Pushed: 2024-06-01T00:04:19.000Z (3 months ago)
Last Synced: 2024-06-04T21:02:04.374Z (3 months ago)
Topics: automation, gui, hooks, linux, python, python-library, pywinauto, qa, testing, testing-tools, ui-automated-tests, ui-automation, uiautomation, user-interface, win32api, windows, windows-api
Language: Python
Homepage: http://pywinauto.github.io/
Size: 25.2 MB
Stars: 4,694
Watchers: 165
Forks: 671
Open Issues: 502
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome - pywinauto/pywinauto - Windows GUI Automation with Python (based on text properties) (Python)
jimsghstars - pywinauto/pywinauto - Windows GUI Automation with Python (based on text properties) (Python)

README

        [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=UGXPL6AD29PHW)

[![Join the chat at https://gitter.im/pywinauto/pywinauto](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pywinauto/pywinauto?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Documentation Status](https://readthedocs.org/projects/pywinauto/badge/?version=latest)](http://pywinauto.readthedocs.org/en/latest/?badge=latest)

[![Windows Tests](https://ci.appveyor.com/api/projects/status/ykk30v7vcvkmpnoq/branch/master?svg=true&passingText=Windows%20tests%20-%20OK&pendingText=Windows%20tests%20-%20running&failingText=Windows%20tests%20-%20fail)](https://ci.appveyor.com/project/pywinauto/pywinauto)

[![Linux Tests](https://travis-ci.org/pywinauto/pywinauto.svg?branch=master)](https://travis-ci.org/pywinauto/pywinauto)

[![codecov.io](http://codecov.io/github/pywinauto/pywinauto/coverage.svg?branch=master)](http://codecov.io/github/pywinauto/pywinauto?branch=master)

[![Code Health](https://landscape.io/github/pywinauto/pywinauto/master/landscape.svg?style=flat)](https://landscape.io/github/pywinauto/pywinauto/master)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/b823b31c0f2b48d6873326d038c5a516)](https://www.codacy.com/app/pywinauto/pywinauto?utm_source=github.com&utm_medium=referral&utm_content=pywinauto/pywinauto&utm_campaign=Badge_Grade)

[![Code Quality: Python](https://img.shields.io/lgtm/grade/python/g/pywinauto/pywinauto.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/pywinauto/pywinauto/context:python)

[![Total Alerts](https://img.shields.io/lgtm/alerts/g/pywinauto/pywinauto.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/pywinauto/pywinauto/alerts)

pywinauto

============

pywinauto is a set of python modules to automate the Microsoft Windows GUI. 

At its simplest it allows you to send mouse and keyboard actions to windows 

dialogs and controls, but it has support for more complex actions like getting text data.

Supported technologies under the hood: Win32 API (`backend="win32"`; used by default),

MS UI Automation (`backend="uia"`). User input emulation modules

 `mouse` and `keyboard` work on both Windows and Linux.

### Enjoying this?

Just star the repo or make a donation.

[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=UGXPL6AD29PHW)

Your help is valuable since this is a hobby project for all of us: we do 

[new features](https://github.com/pywinauto/pywinauto/issues?q=is%3Aissue+is%3Aopen+label%3A%22New+Feature%22) development during out-of-office hours.

 * In general the library **tends to be cross-platform** in the near future (Linux in 2018, macOS in 2019).

 * Reliable text based **"record-replay"** generator is also a high priority feature under development.

 * More feature requests and discusions are welcome in [the issues](https://github.com/pywinauto/pywinauto/issues).

### Setup

* run `pip install -U pywinauto` (dependencies will be installed automatically)

### Documentation / Help

* [Short Intro on ReadTheDocs](https://pywinauto.readthedocs.io/en/latest/)

* [Getting Started Guide](https://pywinauto.readthedocs.io/en/latest/getting_started.html) (core concept, Spy/Inspect tools etc.)

* [StackOverflow tag](https://stackoverflow.com/questions/tagged/pywinauto) for questions

* [Mailing list](https://sourceforge.net/p/pywinauto/mailman/)

### Simple Example

It is simple and the resulting scripts are very readable. How simple?

```python

from pywinauto.application import Application

app = Application().start("notepad.exe")

app.UntitledNotepad.menu_select("Help->About Notepad")

app.AboutNotepad.OK.click()

app.UntitledNotepad.Edit.type_keys("pywinauto Works!", with_spaces = True)

```

### MS UI Automation Example

More detailed example for `explorer.exe`:

```python

from pywinauto import Desktop, Application

Application().start('explorer.exe "C:\\Program Files"')

# connect to another process spawned by explorer.exe

# Note: make sure the script is running as Administrator!

app = Application(backend="uia").connect(path="explorer.exe", title="Program Files")

app.ProgramFiles.set_focus()

common_files = app.ProgramFiles.ItemsView.get_item('Common Files')

common_files.right_click_input()

app.ContextMenu.Properties.invoke()

# this dialog is open in another process (Desktop object doesn't rely on any process id)

Properties = Desktop(backend='uia').Common_Files_Properties

Properties.print_control_identifiers()

Properties.Cancel.click()

Properties.wait_not('visible') # make sure the dialog is closed

```

### Dependencies (if install manually)

* Windows:

  - [pyWin32](https://github.com/mhammond/pywin32/)

  - [comtypes](https://github.com/enthought/comtypes)

  - [six](https://pypi.python.org/pypi/six)

* Linux:

  - [python-xlib](https://github.com/python-xlib/python-xlib)

  - [six](https://pypi.python.org/pypi/six)

* Optional packages:

  - Install [Pillow](https://pypi.python.org/pypi/Pillow) (by `pip install -U Pillow`) to be able to call `capture_as_image()` method for making a control's snapshot.

### Packages required for running unit tests

* [Pillow](https://pypi.python.org/pypi/Pillow)

* [coverage](https://pypi.python.org/pypi/coverage)

Run all the tests: `python ./pywinauto/unittests/testall.py`

### Contribution

Pull requests are very welcome. Read [Contribution Guide](https://github.com/pywinauto/pywinauto/wiki/Contribution-Guide-(draft)) for more details about unit tests, coding conventions, etc.

### Copyrights

Pywinauto for native Windows GUI was initially written by **Mark Mc Mahon**. 

Mark brought many great ideas into the life using power of Python. 

Further contributors are inspired of the nice API so that the development continues.

Starting from 0.6.0 pywinauto is distributed under the BSD 3-clause license.

Pywinauto 0.5.4 and before was distributed under the LGPL v2.1 or later.

* (c) [The Open Source Community](https://github.com/pywinauto/pywinauto/graphs/contributors), 2015-2018 (0.6.0+ development)

* (c) Intel Corporation, 2015 (0.5.x maintenance)

* (c) Michael Herrmann, 2012-2013 (0.4.2)

* (c) Mark Mc Mahon, 2006-2010 (0.4.0 and before)