Skip to content

Commit 4aefa08

Browse files
committed
Strip unneeded whitespace characters from documentation
1 parent d71bc54 commit 4aefa08

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Add SAML support to your Python software using this library.
1010
Forget those complicated libraries and use the open source library provided
1111
and supported by OneLogin Inc.
1212

13-
This version supports Python3, There is a separate version that only support Python2: [python-saml](https://pypi.python.org/pypi/python-saml)
13+
This version supports Python3, There is a separate version that only support Python2: [python-saml](https://pypi.python.org/pypi/python-saml)
1414

1515
#### Warning ####
1616

17-
Update python3-saml to 1.2.1 that patch 1.2.0 (that had a bug on signature validation process (when using wantAssertionsSigned and wantMessagesSigned).
17+
Update python3-saml to 1.2.1 that patch 1.2.0 (that had a bug on signature validation process (when using wantAssertionsSigned and wantMessagesSigned).
1818

1919
1.2.0 version includes a security patch that contains extra validations that will prevent signature wrapping attacks.
2020

@@ -93,7 +93,7 @@ The toolkit is hosted on github. You can download it from:
9393
* Lastest release: https://github.com/onelogin/python3-saml/releases/latest
9494
* Master repo: https://github.com/onelogin/python3-saml/tree/master
9595

96-
Copy the core of the library (src/onelogin/saml2 folder) and merge the setup.py inside the python application. (each application has its structure so take your time to locate the Python SAML toolkit in the best place).
96+
Copy the core of the library (src/onelogin/saml2 folder) and merge the setup.py inside the python application. (each application has its structure so take your time to locate the Python SAML toolkit in the best place).
9797

9898
#### Option 2. Download from pypi ####
9999

@@ -916,7 +916,7 @@ Auxiliary class that contains several methods
916916

917917
A class that contains methods to handle XMLs
918918

919-
* ***to_string*** Serialize an element to an encoded string representation of its XML tree.
919+
* ***to_string*** Serialize an element to an encoded string representation of its XML tree.
920920
* ***to_etree*** Parses an XML document or fragment from a string.
921921
* ***validate_xml*** Validates a xml against a schema
922922
* ***query*** Extracts nodes that match the query from the Element
@@ -930,7 +930,7 @@ A class that contains methods to obtain and parse metadata from IdP
930930
* ***parse_remote*** Get the metadata XML from the provided URL and parse it, returning a dict with extracted data
931931
* ***parse*** Parse the Identity Provider metadata and returns a dict with extracted data
932932
* ***merge_settings*** Will update the settings with the provided new settings data extracted from the IdP metadata
933-
933+
934934

935935
For more info, look at the source code; each method is documented and details about what does and how to use it are provided. Make sure to also check the doc folder where HTML documentation about the classes and methods is provided.
936936

@@ -1011,7 +1011,7 @@ The Onelogin's Python Toolkit allows you to provide the settings info in 2 ways:
10111011

10121012
In the index.py file we define the app.config['SAML_PATH'], that will target to the 'saml' folder. We require it in order to load the settings files.
10131013

1014-
First we need to edit the saml/settings.json, configure the SP part and review the metadata of the IdP and complete the IdP info. Later edit the saml/advanced_settings.json files and configure the how the toolkit will work. Check the settings section of this document if you have any doubt.
1014+
First we need to edit the saml/settings.json, configure the SP part and review the metadata of the IdP and complete the IdP info. Later edit the saml/advanced_settings.json files and configure the how the toolkit will work. Check the settings section of this document if you have any doubt.
10151015

10161016
####IdP setup####
10171017

@@ -1044,7 +1044,7 @@ Notice that all the SAML Requests and Responses are handled at a unique view (in
10441044
You'll need a virtualenv with the toolkit installed on it.
10451045

10461046
To run the demo you need to install the requirements first. Load your
1047-
virtualenv and execute:
1047+
virtualenv and execute:
10481048
```
10491049
pip install -r demo-django/requirements.txt
10501050
```
@@ -1084,7 +1084,7 @@ The Onelogin's Python Toolkit allows you to provide the settings info in 2 ways:
10841084

10851085
After set the SAML_FOLDER in the demo/settings.py, the settings of the python toolkit will be loaded on the django web.
10861086

1087-
First we need to edit the saml/settings.json, configure the SP part and review the metadata of the IdP and complete the IdP info. Later edit the saml/advanced_settings.json files and configure the how the toolkit will work. Check the settings section of this document if you have any doubt.
1087+
First we need to edit the saml/settings.json, configure the SP part and review the metadata of the IdP and complete the IdP info. Later edit the saml/advanced_settings.json files and configure the how the toolkit will work. Check the settings section of this document if you have any doubt.
10881088

10891089
####IdP setup####
10901090

@@ -1096,7 +1096,7 @@ This demo works very similar to the flask-demo (We did it intentionally).
10961096

10971097
###Getting up and running on Heroku###
10981098

1099-
Getting python3-saml up and running on Heroku will require some extra legwork: python3-saml depends on python-xmlsec which depends on headers from the xmlsec1-dev linux package to install correctly.
1099+
Getting python3-saml up and running on Heroku will require some extra legwork: python3-saml depends on python-xmlsec which depends on headers from the xmlsec1-dev linux package to install correctly.
11001100

11011101
First you will need to add the ```apt``` buildpack to your build server:
11021102

0 commit comments

Comments
 (0)