Skip to content

Commit eb6abc3

Browse files
committed
Add "Running the Tests" section to README
1 parent 34d48f7 commit eb6abc3

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -447,6 +447,46 @@ JWTTokenUserAuthentication backend
447447
...
448448
}
449449
450+
Running the Tests
451+
-----------------
452+
453+
To run the tests, first `install pyenv
454+
<https://github.com/pyenv/pyenv#installation>`__. Next, install the relevant
455+
Python minor versions and create a ``.python-version`` file in your cloned
456+
repo's directory:
457+
458+
.. code-block:: bash
459+
460+
pyenv install 3.6.x
461+
pyenv install 3.5.x
462+
pyenv install 3.4.x
463+
pyenv install 2.7.x
464+
cd <repo directory>
465+
cat > .python-version <<EOF
466+
3.6.x
467+
3.5.x
468+
3.4.x
469+
2.7.x
470+
EOF
471+
472+
Above, the ``x`` in each case should be replaced with the latest corresponding
473+
patch version. The ``.python-version`` file will tell pyenv and tox that
474+
you're testing against multiple versions of Python. Next, install and run tox:
475+
476+
.. code-block:: bash
477+
478+
pip install tox
479+
tox
480+
481+
Alternatively, if you'd like to avoid using tox, you can set up your
482+
environment and run the tests manually:
483+
484+
.. code-block:: bash
485+
486+
pip install -r requirements.txt
487+
./setup.py develop
488+
./runtests.py
489+
450490
Acknowledgements
451491
----------------
452492

0 commit comments

Comments
 (0)