README.rst 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. *************************
  2. PySAML2 - SAML2 in Python
  3. *************************
  4. :Version: see VERSION_
  5. :Documentation: https://pysaml2.readthedocs.io/
  6. .. image:: https://api.travis-ci.org/IdentityPython/pysaml2.png?branch=master
  7. :target: https://travis-ci.org/IdentityPython/pysaml2
  8. .. image:: https://img.shields.io/pypi/pyversions/pysaml2.svg
  9. :target: https://pypi.org/project/pysaml2/
  10. .. image:: https://img.shields.io/pypi/v/pysaml2.svg
  11. :target: https://pypi.org/project/pysaml2/
  12. PySAML2 is a pure python implementation of SAML Version 2 Standard. It contains
  13. all necessary pieces for building a SAML2 service provider or an identity
  14. provider. The distribution contains examples of both. Originally written to
  15. work in a WSGI environment there are extensions that allow you to use it with
  16. other frameworks.
  17. Install
  18. =======
  19. You can install with `pip install pysaml2`
  20. Testing
  21. =======
  22. PySAML2 uses the pytest_ framework for testing. To run the tests on your
  23. system's version of python:
  24. 1. Create and activate a virtualenv_
  25. 2. Inside the virtualenv_, install the dependencies needed for testing
  26. :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 pyenv_ with tox_.
  29. Please contribute!
  30. ==================
  31. To help out, you could:
  32. 1. Test and report any bugs or other difficulties.
  33. 2. Implement missing features.
  34. 3. Write more unit tests.
  35. **If you have the time and inclination I'm looking for Collaborators**
  36. .. _VERSION: VERSION
  37. .. _pytest: https://docs.pytest.org/en/latest/
  38. .. _virtualenv: https://virtualenv.pypa.io/en/stable/
  39. .. _pyenv: https://github.com/yyuu/pyenv
  40. .. _tox: https://tox.readthedocs.io/en/latest/