GeezerVison is showing github.com — add test_requirements.txt and more test running instructions · mpdaugherty/python-github3@9517cf5
File tree
Expand file treeCollapse file tree
Open diff view settings
Expand file treeCollapse file tree
Open diff view settings
Collapse file
Copy file name to clipboardExpand all lines: README.rst +6-2Lines changed: 6 additions & 2 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -58,5 +58,9 @@ Contribute |
58 | 58 | 4. Add you to ``AUTHORS`` |
59 | 59 | 5. Pull request it |
60 | 60 |
|
61 | | -**Note**: I use `nose <http://readthedocs.org/docs/nose/en/latest/>`_ test environment, |
62 | | -with `mock <http://www.voidspace.org.uk/python/mock/>`_ ``pip install nose mock`` |
| 61 | +Tests |
| 62 | +----- |
| 63 | + |
| 64 | +Test and docs requirements are listed in ``test_requirements.txt``. |
| 65 | +Run ``pip install -r test_requirements.txt`` to install them and ``nosetests`` |
| 66 | +to run tests |
Collapse file
Copy file name to clipboardExpand all lines: docs/installation.rst +10-4Lines changed: 10 additions & 4 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -15,15 +15,21 @@ Dependencies |
15 | 15 | Required |
16 | 16 | ......... |
17 | 17 |
|
18 | | -This library only depends on `request library`_ module. |
| 18 | +This library depends only on the `requests`_ module. |
19 | 19 |
|
20 | | -If you install ``pygithub3`` with ``pip`` all is done. The best option |
| 20 | +If you install ``pygithub3`` with ``pip`` all is done. This is the best option. |
21 | 21 |
|
22 | 22 | Optional |
23 | 23 | ......... |
24 | 24 |
|
25 | | -If you want to run the test suite, you must install `nose`_ and `mock`_ |
| 25 | +The test suite uses `nose`_, `mock`_, and `unittest2`_. Compiling the |
| 26 | +documentation requires `sphinx`_. |
26 | 27 |
|
27 | | -.. _request library: http://docs.python-requests.org/en/v0.10.6/index.html |
| 28 | +Install all of these by running ``pip install -r test_requirements.txt``. Then |
| 29 | +just run ``nosetests`` to run the tests. |
| 30 | + |
| 31 | +.. _requests: http://docs.python-requests.org/en/v0.10.6/index.html |
28 | 32 | .. _nose: http://readthedocs.org/docs/nose/en/latest |
29 | 33 | .. _mock: http://pypi.python.org/pypi/mock |
| 34 | +.. _unittest2: http://pypi.python.org/pypi/unittest2 |
| 35 | +.. _sphinx: http://sphinx.pocoo.org/ |
Collapse file
Copy file name to clipboard +4Lines changed: 4 additions & 0 deletions | Original file line number | Diff line number | Diff line change |
|---|
|
| 1 | +nose |
| 2 | +unittest2 |
| 3 | +mock |
| 4 | +sphinx |