README.rst 2.4 KB

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