summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Kluyver <takowl@gmail.com>2014-06-01 18:04:46 -0700
committerThomas Kluyver <takowl@gmail.com>2014-06-01 20:40:08 -0700
commitc2be049cb06b306a17d4fac689fcb88f2ee9cf63 (patch)
tree3bfa370300862cff0314fb44cb0ec34cb59d48c9
parentac0d5797ccb11a1e9a48f0b825c91743ebd74e92 (diff)
downloadpexpect-c2be049cb06b306a17d4fac689fcb88f2ee9cf63.tar.gz
Update DEVELOPERS file
-rw-r--r--DEVELOPERS52
-rw-r--r--DEVELOPERS.rst12
-rw-r--r--README.rst2
3 files changed, 13 insertions, 53 deletions
diff --git a/DEVELOPERS b/DEVELOPERS
deleted file mode 100644
index 8f9aa43..0000000
--- a/DEVELOPERS
+++ /dev/null
@@ -1,52 +0,0 @@
-
-To edit and test code and to run the Pyunit tests you need to source the
-environment file provided in the root of the development directory.
-For example:
-
- . test.env
-
-Then to run unit tests run the testall.py script under the tools/ directory.
-For example:
-
- ./tools/testall.py
-
-The test.env environment file sets the PYTHONPATH to the Pexpect development
-root directory. This way the unit tests and python interpreter will import the
-development version of Pexpect instead of any older versions that you may have
-installed on the system.
-
-The Pyunit tests are all located in the tests/ directory. To add a new unit
-test all you have to do is create the file in the tests/ directory with a
-filename in this format:
-
- test_*.py
-
-The testall.py script in the tools/ directory will automatically add all
-test_*.py files to the test suite. To create a new unit test follow the example
-of one of the other test_*.py scripts. Basically, a new unit test will follow
-this template:
-
-<pre>
-#!/usr/bin/env python
-import pexpect
-import unittest
-import PexpectTestCase
-
-# 1. Derive your test case class from PexpectTestCase.PexpectTestCase.
-# 2. At the end of this script add your test case class to the suite using
-# unittest.MakeSuite.
-# 3. All test case methods should be named like test_*.
-class TestCaseFoo (PexpectTestCase.PexpectTestCase):
-
- def test_case (self):
- assert (False), "This is an example template."
-
- def test_case_something_else (self):
- assert (False), "This is an example template."
-
-if __name__ == '__main__':
- unittest.main()
-
-suite = unittest.makeSuite(TestCaseFoo,'test')
-</pre>
-
diff --git a/DEVELOPERS.rst b/DEVELOPERS.rst
new file mode 100644
index 0000000..d5e4475
--- /dev/null
+++ b/DEVELOPERS.rst
@@ -0,0 +1,12 @@
+To run the tests, use `py.test <http://pytest.org/latest/>`_::
+
+ py.test
+
+The tests are all located in the tests/ directory. To add a new unit
+test all you have to do is create the file in the tests/ directory with a
+filename in this format::
+
+ test_*.py
+
+New test case classes may wish to inherit from ``PexpectTestCase.PexpectTestCase``
+in the tests directory, which sets up some convenient functionality.
diff --git a/README.rst b/README.rst
index 351abad..e0bbd84 100644
--- a/README.rst
+++ b/README.rst
@@ -22,7 +22,7 @@ It should work on any platform that supports the standard Python pty module.
The Pexpect interface was designed to be easy to use.
If you want to work with the development version of the source code then please
-read the DEVELOPERS document in the root of the source code tree.
+read the DEVELOPERS.rst document in the root of the source code tree.
Free, open source, and all that good stuff.