summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorIvan Kanakarakis <ivan.kanak@gmail.com>2018-07-04 01:37:50 +0300
committerIvan Kanakarakis <ivan.kanak@gmail.com>2018-07-04 01:37:50 +0300
commit3113cffb571b90d044bd1218712e27732777f87d (patch)
tree02145d58d238a1fa18e1c0dcf779827bf190f911 /README.rst
parent5e26cf9c4cfc2c4b911c0cf28c2fa1472418fcd1 (diff)
downloadpysaml2-3113cffb571b90d044bd1218712e27732777f87d.tar.gz
Reformat README
Signed-off-by: Ivan Kanakarakis <ivan.kanak@gmail.com>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst34
1 files changed, 21 insertions, 13 deletions
diff --git a/README.rst b/README.rst
index 4805e4d3..51a5e096 100644
--- a/README.rst
+++ b/README.rst
@@ -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
@@ -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!
@@ -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/