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