Merge pull request #372 from ashimaathri/update-readme-with-testing

Update README with instructions for testing

.gitignore

@@ -33,6 +33,8 @@ tmp*
 _build/
 .cache
 *.swp
+.tox
+env
 
 example/idp3/htdocs/login.mako
 
@@ -192,8 +194,6 @@ example/sp-repoze/old_sp.xml
 
 example/sp-repoze/sp_conf_2.Pygmalion
 
-.gitignore.swp
-
 example/sp-repoze/sp_conf_2.py
 
 sp.xml

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/>`_.

tests/test_requirements.txt

@@ -1,3 +1,4 @@
+mock==2.0.0
 pymongo==3.0.1
+pytest==3.0.3
 responses==0.5.0
-mock

tox.ini

@@ -2,6 +2,5 @@
 envlist = py27,py34
 
 [testenv]
-deps = pytest
-       -rtests/test_requirements.txt
+deps = -rtests/test_requirements.txt
 commands = py.test tests/