README.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. *************************
  2. PySAML2 - SAML2 in Python
  3. *************************
  4. :Author: Roland Hedberg
  5. :Version: 4.0.4
  6. .. image:: https://api.travis-ci.org/rohe/pysaml2.png?branch=master
  7. :target: https://travis-ci.org/rohe/pysaml2
  8. .. image:: https://img.shields.io/pypi/pyversions/pysaml2.svg
  9. :target: https://pypi.python.org/pypi/pysaml2
  10. .. image:: https://img.shields.io/pypi/v/pysaml2.svg
  11. :target: https://pypi.python.org/pypi/pysaml2
  12. .. image:: https://img.shields.io/pypi/dm/pysaml2.svg
  13. :target: https://pypi.python.org/pypi/pysaml2
  14. .. image:: https://landscape.io/github/rohe/pysaml2/master/landscape.svg?style=flat
  15. :target: https://landscape.io/github/rohe/pysaml2/master
  16. PySAML2 is a pure python implementation of SAML2. It contains all
  17. necessary pieces for building a SAML2 service provider or an identity provider.
  18. The distribution contains examples of both.
  19. Originally written to work in a WSGI environment there are extensions that
  20. allow you to use it with other frameworks.
  21. Testing
  22. =======
  23. PySAML2 uses the `pytest <http://doc.pytest.org/en/latest/>`_ framework for
  24. testing. To run the tests on your system's version of python
  25. 1. Create and activate a `virtualenv <https://virtualenv.pypa.io/en/stable/>`_.
  26. 2. Inside the virtualenv, install the dependencies needed for testing :code:`pip install -r tests/test_requirements.txt`
  27. 3. Run the tests :code:`py.test tests`
  28. To run tests in multiple python environments, you can use
  29. `pyenv <https://github.com/yyuu/pyenv>`_ with `tox <https://tox.readthedocs.io/en/latest/>`_.