From 4c4f2f4b096793e4b64cf3188413defe279bf482 Mon Sep 17 00:00:00 2001 From: Ashima Athri Date: Wed, 19 Oct 2016 19:01:43 -0400 Subject: [PATCH] Update readme with instructions for running tests locally --- README.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.rst b/README.rst index f6abb5d..205c925 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 `_ framework for +testing. To run the tests on your system's version of python + +1. Create and activate a `virtualenv `_. +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 `_ with `tox `_.