README.rst
1.. image:: https://travis-ci.org/pexpect/pexpect.svg?branch=master
2 :target: https://travis-ci.org/pexpect/pexpect
3 :align: right
4 :alt: Build status
5
6Pexpect is a Pure Python Expect-like module
7
8Pexpect makes Python a better tool for controlling other applications.
9
10Pexpect is a pure Python module for spawning child applications; controlling
11them; and responding to expected patterns in their output. Pexpect works like
12Don Libes' Expect. Pexpect allows your script to spawn a child application and
13control it as if a human were typing commands.
14
15Pexpect can be used for automating interactive applications such as ssh, ftp,
16passwd, telnet, etc. It can be used to a automate setup scripts for duplicating
17software package installations on different servers. It can be used for
18automated software testing. Pexpect is in the spirit of Don Libes' Expect, but
19Pexpect is pure Python.
20
21The main features of Pexpect require the pty module in the Python standard
22library, which is only available on Unix-like systems. Some features—waiting
23for patterns from file descriptors or subprocesses—are also available on
24Windows.
25
26If you want to work with the development version of the source code then please
27read the DEVELOPERS.rst document in the root of the source code tree.
28
29Free, open source, and all that good stuff.
30
31You can install Pexpect using pip::
32
33 pip install pexpect
34
35`Docs on ReadTheDocs <https://pexpect.readthedocs.io/>`_
36
37PEXPECT LICENSE::
38
39 http://opensource.org/licenses/isc-license.txt
40
41 Copyright (c) 2013-2016, Pexpect development team
42 Copyright (c) 2012, Noah Spurrier <noah@noah.org>
43
44 PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY
45 PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE
46 COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES.
47 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
48 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
49 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
50 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
51 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
52 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
53 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
54
55This license is approved by the OSI and FSF as GPL-compatible.
56
