Skip to content

Commit 4c4f2f4

Browse files
committed
Update readme with instructions for running tests locally
1 parent a980019 commit 4c4f2f4

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,15 @@ necessary pieces for building a SAML2 service provider or an identity provider.
2626
The distribution contains examples of both.
2727
Originally written to work in a WSGI environment there are extensions that
2828
allow you to use it with other frameworks.
29+
30+
Testing
31+
=======
32+
PySAML2 uses the `pytest <http://doc.pytest.org/en/latest/>`_ framework for
33+
testing. To run the tests on your system's version of python
34+
35+
1. Create and activate a `virtualenv <https://virtualenv.pypa.io/en/stable/>`_.
36+
2. Inside the virtualenv, install the dependencies needed for testing :code:`pip install -r tests/test_requirements.txt`
37+
3. Run the tests :code:`py.test tests`
38+
39+
To run tests in multiple python environments, you can use
40+
`pyenv <https://github.com/yyuu/pyenv>`_ with `tox <https://tox.readthedocs.io/en/latest/>`_.

0 commit comments

Comments
 (0)