Skip to content

Commit

Permalink
Fix renamed modules in the docs.
Browse files Browse the repository at this point in the history
Remove output folder with the docs from repo.
Update Readme.
  • Loading branch information
vasily-v-ryabov committed Oct 12, 2016
1 parent d35f551 commit 3290eab
Show file tree
Hide file tree
Showing 124 changed files with 128 additions and 32,549 deletions.
82 changes: 41 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,63 @@
pywinauto
============

[![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)
[![Build status](https://ci.appveyor.com/api/projects/status/ykk30v7vcvkmpnoq/branch/master?svg=true&passingText=unit%20tests%20-%20OK&pendingText=unit%20tests%20-%20running&failingText=unit%20tests%20-%20fail)](https://ci.appveyor.com/project/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)

Current 0.5.x maintainance is lead by © Intel Corporation, 2015

pywinauto (c) Mark Mc Mahon and [Contributors](https://github.com/pywinauto/pywinauto/graphs/contributors), 2006-2015

pywinauto
============
pywinauto is a set of python modules to automate the Microsoft Windows GUI.
At it’s simplest it allows you to send mouse and keyboard actions to windows
dialogs and controls, but It has support for more complex controls also.
dialogs and controls, but it has support for more complex actions like getting text data.

Recommended usage: 64-bit Python is for 64-bit applications; 32-bit Python is for 32-bit ones.

### Setup
* Install [pyWin32 extensions](http://sourceforge.net/projects/pywin32/files/pywin32/) (no need for Active Python)
* Download [latest pywinauto release](https://github.com/pywinauto/pywinauto/releases/download/0.5.3/pywinauto-0.5.3.zip)
* Just unpack and run `python setup.py install`

or

* run `pip install pywinauto` (pypiwin32 will be installed automatically)

### Optional packages
* Install [Pillow](https://pypi.python.org/pypi/Pillow) (PIL fork) to be able to call `CaptureAsImage()` method.

### Documentation
* [Introduction](http://pywinauto.github.io/docs/)
* [Table of contents](http://pywinauto.github.io/docs/contents.html)
* [Change Log / History](http://pywinauto.github.io/docs/HISTORY.html)
* [HowTo's](http://pywinauto.github.io/docs/HowTo.html)
* [Code examples (gists) on gist.github.com](https://gist.github.com/vasily-v-ryabov)
* [Mailing list](https://sourceforge.net/p/pywinauto/mailman/)
* run `pip install -U pywinauto` (dependencies will be installed automatically)

### 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.MenuSelect("Help->About Notepad")
app.AboutNotepad.OK.Click()
app.UntitledNotepad.Edit.TypeKeys ("pywinauto Works!", with_spaces = True)
app.UntitledNotepad.Edit.TypeKeys("pywinauto Works!", with_spaces = True)
```

### Supported controls
* Native Windows controls (full support through Win32 API)
* .NET Windows Forms (partial support through Win32 API, some basic controls only)
### Documentation
* [Introduction](http://pywinauto.readthedocs.io/en/latest/)
* [Table of contents](http://pywinauto.readthedocs.io/en/latest/contents.html)
* [Change Log / History](http://pywinauto.readthedocs.io/en/latest/HISTORY.html)
* [HowTo's](http://pywinauto.readthedocs.io/en/latest/HowTo.html)
* [Code examples (gists) on gist.github.com](https://gist.github.com/vasily-v-ryabov)
* [Mailing list](https://sourceforge.net/p/pywinauto/mailman/)

### Continuous Integration / Coverage / Code Issues
* [![Build status](https://ci.appveyor.com/api/projects/status/github/pywinauto/pywinauto?svg=true&passingText=unit%20tests%20-%20OK&pendingText=unit%20tests%20-%20running&failingText=unit%20tests%20-%20fail)](https://ci.appveyor.com/project/pywinauto/pywinauto)
* [![codecov.io](http://codecov.io/github/pywinauto/pywinauto/coverage.svg?branch=master)](http://codecov.io/github/pywinauto/pywinauto?branch=master)
* [![Code Issues](http://www.quantifiedcode.com/api/v1/project/9d5d994af16f46a28961f01dfc63091d/badge.svg)](https://www.quantifiedcode.com/app/project/gh:pywinauto:pywinauto)
* [![Code Health](https://landscape.io/github/pywinauto/pywinauto/master/landscape.svg?style=flat)](https://landscape.io/github/pywinauto/pywinauto/master)
### Dependencies (if install manually):
* [pyWin32](http://sourceforge.net/projects/pywin32/files/pywin32/) only

### Downloads statistics
* PyPI: [![Daily downloads](https://img.shields.io/pypi/dd/pywinauto.svg)](https://pypi.python.org/pypi/pywinauto) [![Weekly downloads](https://img.shields.io/pypi/dw/pywinauto.svg)](https://pypi.python.org/pypi/pywinauto) [![Monthly downloads](https://img.shields.io/pypi/dm/pywinauto.svg)](https://pypi.python.org/pypi/pywinauto)
* GitHub: [![GitHub downloads](https://img.shields.io/github/downloads/pywinauto/pywinauto/0.5.4/pywinauto-0.5.4.zip.svg)](https://github.com/pywinauto/pywinauto/releases/download/0.5.4/pywinauto-0.5.4.zip)
Optional packages:
* Install [Pillow](https://pypi.python.org/pypi/Pillow) (by `pip install -U Pillow`) to be able to call `CaptureAsImage()` method for making control's snapshot.

#### Packages required for running unit tests
* [Pillow](https://pypi.python.org/pypi/Pillow) or PIL
### Packages required for running unit tests
* [Pillow](https://pypi.python.org/pypi/Pillow)
* [coverage](https://pypi.python.org/pypi/coverage)

(Python 3.5 may require VC++ 2015 re-distributable package)
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 style 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.

Pywinauto 0.5.4 and before is distributed under the LGPL v2.1 or later. Starting from 0.6.0 pywinauto will be distributed under the BSD 3-clause license.
* (c) [The Open Source Community](https://github.com/pywinauto/pywinauto/graphs/contributors), 2015-2016 (0.6.0+ development)
* (c) Intel Corporation, 2015 (led 0.5.x maintenance)
* (c) Michael Herrmann, 2012-2013 (0.4.2)
* (c) Mark Mc Mahon, 2006-2010 (0.4.0 and before)
6 changes: 3 additions & 3 deletions docs/code/code.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Controls Reference
:maxdepth: 1

pywinauto.controls.common_controls.txt
pywinauto.controls.HwndWrapper.txt
pywinauto.controls.hwndwrapper.txt
pywinauto.controls.menuwrapper.txt
pywinauto.controls.win32_controls.txt
pywinauto.controls.uiawrapper.txt
Expand All @@ -34,7 +34,7 @@ Sendkeys
.. toctree::
:maxdepth: 1

pywinauto.SendKeysCtypes.txt
pywinauto.keyboard.txt

Included 3rd party modules
==============================
Expand Down Expand Up @@ -72,5 +72,5 @@ Internal modules
pywinauto.fuzzydict.txt
pywinauto.actionlogger.txt
pywinauto.sysinfo.txt
pywinauto.RemoteMemoryBlock.txt
pywinauto.remote_memory_block.txt

6 changes: 0 additions & 6 deletions docs/code/pywinauto.RemoteMemoryBlock.txt

This file was deleted.

6 changes: 0 additions & 6 deletions docs/code/pywinauto.SendKeysCtypes.txt

This file was deleted.

6 changes: 0 additions & 6 deletions docs/code/pywinauto.XMLHelpers.txt

This file was deleted.

7 changes: 0 additions & 7 deletions docs/code/pywinauto.controls.HwndWrapper.txt

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
pywinauto.controls.HwndWrapper
pywinauto.controls.hwndwrapper
------------------------------
.. automodule:: pywinauto.controls.HwndWrapper
.. automodule:: pywinauto.controls.hwndwrapper
:members:
:undoc-members:
:show-inheritance:
Expand Down
6 changes: 6 additions & 0 deletions docs/code/pywinauto.remote_memory_block.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pywinauto.remote_memory_block
---------------------------
.. automodule:: pywinauto.remote_memory_block
:members:
:undoc-members:

6 changes: 6 additions & 0 deletions docs/code/pywinauto.xml_helpers.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pywinauto.xml_helpers
--------------------
.. automodule:: pywinauto.xml_helpers
:members:
:undoc-members:

Loading

0 comments on commit 3290eab

Please sign in to comment.