python-saml-1's Introduction

python-saml

A python interface to produce and consume Security Asserion Markup Language v2.0 (SAML2) messages.

Features

Python 2.7.x, 3.3.x, 3.4.x support

python-saml supports both python 2.7.x+ and 3.3.x+.

SAML conformance

python-saml conforms to the latest SAML (v2.0) standards.

Environment agnostic

python-saml may be used to produce and consume SAML messages regardless of the environment (terminal, WSGI, django) used to call it.

Usage

Check the test suite for additional examples on using the library.

Install

Pre-Install

Linux

apt-get install libxml2-dev libxmlsec1-dev

Mac

brew install libxml2 libxmlsec1

Automated

saml can be installed through easy_install or pip.
```
pip install saml
```

Manual

Clone the saml repository to your local computer.

git clone git://github.com/mehcode/python-saml.git

Change into the saml root directory.
```
cd /path/to/saml
```
Install the project and all its dependencies using pip.
```
pip install .
```

Contributing

Setting up your environment

Follow steps 1 and 2 of the manual installation instructions.

Initialize a virtual environment to develop in. This is done so as to ensure every contributor is working with close-to-identicial versions of packages.
```
mkvirtualenv saml
```
The mkvirtualenv command is available from virtualenvwrapper which can be installed by following: http://virtualenvwrapper.readthedocs.org/en/latest/install.html#basic-installation
Install saml in development mode with testing enabled. This will download all dependencies required for running the unit tests.
```
pip install -e ".[test]"
```

Running the test suite

Set up your environment.
Run the unit tests.
```
py.test
```

License

Unless otherwise noted, all files contained within this project are liensed under the MIT opensource license. See the included file LICENSE or visit opensource.org for more information.

Recommend Projects