add test_requirements.txt and more test running instructions

Nat Williams · Nat Williams · commit 9517cf574615 · 2012-04-16T16:05:51.000-05:00
diff --git a/README.rst b/README.rst
@@ -58,5 +58,9 @@ Contribute
 4. Add you to ``AUTHORS``
 5. Pull request it
 
-**Note**: I use `nose <http://readthedocs.org/docs/nose/en/latest/>`_ test environment,
-with `mock <http://www.voidspace.org.uk/python/mock/>`_ ``pip install nose mock``
+Tests
+-----
+
+Test and docs requirements are listed in ``test_requirements.txt``.
+Run ``pip install -r test_requirements.txt`` to install them and ``nosetests``
+to run tests
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -15,15 +15,21 @@ Dependencies
 Required
 .........
 
-This library only depends on `request library`_ module.
+This library depends only on the `requests`_ module.
 
-If you install ``pygithub3`` with ``pip`` all is done. The best option
+If you install ``pygithub3`` with ``pip`` all is done. This is the best option.
 
 Optional
 .........
 
-If you want to run the test suite, you must install `nose`_ and `mock`_
+The test suite uses `nose`_, `mock`_, and `unittest2`_. Compiling the
+documentation requires `sphinx`_.
 
-.. _request library: http://docs.python-requests.org/en/v0.10.6/index.html
+Install all of these by running ``pip install -r test_requirements.txt``.  Then
+just run ``nosetests`` to run the tests.
+
+.. _requests: http://docs.python-requests.org/en/v0.10.6/index.html
 .. _nose: http://readthedocs.org/docs/nose/en/latest
 .. _mock: http://pypi.python.org/pypi/mock
+.. _unittest2: http://pypi.python.org/pypi/unittest2
+.. _sphinx: http://sphinx.pocoo.org/
diff --git a/test_requirements.txt b/test_requirements.txt
@@ -0,0 +1,4 @@
+nose
+unittest2
+mock
+sphinx

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +nose
 +unittest2
 +mock
 +sphinx