jiuyuan
/
test_ok1
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

contributing: Add instructions from PyCon 

At PyCon we realised that the virtualenv created in the make file wasn't
used in the subsequent steps in CONTRIBUTING.rst. This change removes the
reference the make and suggesting installing tox directly.
Also changed the explanation that follows to make more sense with this
change
This commit is contained in:
Michael Birtwell 2015-09-21 10:49:35 +01:00
parent 8fe5c704e3
commit bb42e43ee7
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.rst
View File

@ -158,13 +158,15 @@ but here is a simple overview:
If you need some help with Git, follow this quick start If you need some help with Git, follow this quick start
guide: https://git.wiki.kernel.org/index.php/QuickStart guide: https://git.wiki.kernel.org/index.php/QuickStart
#. Create a development environment #. Install tox
Tox is used to run all the tests and will automatically setup virtualenvs
to run the tests in.
(will implicitly use http://www.virtualenv.org/en/latest/):: (will implicitly use http://www.virtualenv.org/en/latest/)::
$ make develop $ pip install tox
$ source .env/bin/activate
#. You can now edit your local working copy. #. Run all the tests
You need to have Python 2.7 and 3.4 available in your system. Now You need to have Python 2.7 and 3.4 available in your system. Now
running tests is as simple as issuing this command:: running tests is as simple as issuing this command::
@ -177,7 +179,11 @@ but here is a simple overview:
index where newer (not yet released to pypi) versions of dependencies index where newer (not yet released to pypi) versions of dependencies
(especially ``py``) might be present. (especially ``py``) might be present.
To run tests on py27 and pass options (e.g. enter pdb on failure) #. You can now edit your local working copy.
You can now make the changes you want and run the tests again as necessary.
To run tests on py27 and pass options to pytest (e.g. enter pdb on failure)
to pytest you can do:: to pytest you can do::
$ python runtox.py -e py27 -- --pdb $ python runtox.py -e py27 -- --pdb