Skip to content

Commit

Permalink
Reformat README
Browse files Browse the repository at this point in the history
Signed-off-by: Ivan Kanakarakis <ivan.kanak@gmail.com>
  • Loading branch information
c00kiemon5ter committed Jul 3, 2018
1 parent 5e26cf9 commit 3113cff
Showing 1 changed file with 21 additions and 13 deletions.
34 changes: 21 additions & 13 deletions README.rst
Expand Up @@ -2,8 +2,7 @@
PySAML2 - SAML2 in Python
*************************

:Author: Roland Hedberg
:Version: 4.5.0
:Version: see VERSION_
:Documentation: https://pysaml2.readthedocs.io/

.. image:: https://api.travis-ci.org/IdentityPython/pysaml2.png?branch=master
Expand All @@ -16,23 +15,25 @@ PySAML2 - SAML2 in Python
:target: https://pypi.org/project/pysaml2/


PySAML2 is a pure python implementation of SAML2. It contains all
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.
PySAML2 is a pure python implementation of SAML Version 2 Standard. It contains
all 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`
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 <https://github.com/yyuu/pyenv>`_ with `tox <https://tox.readthedocs.io/en/latest/>`_.
To run tests in multiple python environments, you can use pyenv_ with tox_.


Please contribute!
Expand All @@ -45,3 +46,10 @@ To help out, you could:
3. Write more unit tests.

**If you have the time and inclination I'm looking for Collaborators**


.. _VERSION: VERSION
.. _pytest: https://docs.pytest.org/en/latest/
.. _virtualenv: https://virtualenv.pypa.io/en/stable/
.. _pyenv: https://github.com/yyuu/pyenv
.. _tox: https://tox.readthedocs.io/en/latest/

0 comments on commit 3113cff

Please sign in to comment.