summaryrefslogtreecommitdiff
path: root/doc/index.rst
blob: 83bb7f21274f12db0501732e7915ca8addf5236e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
Pexpect version |version|
=========================

.. image:: https://travis-ci.org/pexpect/pexpect.png?branch=master
   :target: https://travis-ci.org/pexpect/pexpect
   :align: right
   :alt: Build status

Pexpect makes Python a better tool for controlling other
applications.

Pexpect is a pure Python module for spawning child applications;
controlling them; and responding to expected patterns in their output.
Pexpect works like Don Libes' Expect. Pexpect allows your script to
spawn a child application and control it as if a human were typing
commands.

Pexpect can be used for automating interactive applications such as
ssh, ftp, passwd, telnet, etc. It can be used to automate setup
scripts for duplicating software package installations on different
servers. It can be used for automated software testing. Pexpect is in
the spirit of Don Libes' Expect, but Pexpect is pure Python. Unlike
other Expect-like modules for Python, Pexpect does not require TCL or
Expect nor does it require C extensions to be compiled. It should work
on any platform that supports the standard Python pty module. The
Pexpect interface was designed to be easy to use.

Contents:

.. toctree::
   :maxdepth: 2

   install
   overview
   api/index
   examples
   FAQ
   commonissues
   history

Pexpect is developed `on Github <http://github.com/pexpect/pexpect>`_. Please
report `issues <https://github.com/pexpect/pexpect/issues>`_ there as well.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`