summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorAshima Athri <ashimaathri@gmail.com>2016-10-19 19:01:43 -0400
committerAshima Athri <ashimaathri@gmail.com>2016-10-20 09:27:26 -0400
commit4c4f2f4b096793e4b64cf3188413defe279bf482 (patch)
tree79b8f5be8e4903a24e288e83b621255ca3297c04 /README.rst
parenta9800192a5ca0b14457fc32518dd21a505f7d155 (diff)
downloadpysaml2-4c4f2f4b096793e4b64cf3188413defe279bf482.tar.gz
Update readme with instructions for running tests locally
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index f6abb5df..205c925e 100644
--- a/README.rst
+++ b/README.rst
@@ -26,3 +26,15 @@ necessary pieces for building a SAML2 service provider or an identity provider.
The distribution contains examples of both.
Originally written to work in a WSGI environment there are extensions that
allow you to use it with other frameworks.
+
+Testing
+=======
+PySAML2 uses the `pytest <http://doc.pytest.org/en/latest/>`_ framework for
+testing. To run the tests on your system's version of python
+
+1. Create and activate a `virtualenv <https://virtualenv.pypa.io/en/stable/>`_.
+2. Inside the virtualenv, install the dependencies needed for testing :code:`pip install -r tests/test_requirements.txt`
+3. Run the tests :code:`py.test tests`
+
+To run tests in multiple python environments, you can use
+`pyenv <https://github.com/yyuu/pyenv>`_ with `tox <https://tox.readthedocs.io/en/latest/>`_.