Metadata-Version: 2.0
Name: django-saml-idp
Version: 0.24.0
Summary: SAML 2.0 IdP for Django
Home-page: http://github.com/deforestg/dj-saml-idp
Author: Gabriel de Forest, Sebastian Vetter
Author-email: sebastian@mobify.com
License: MIT
Platform: UNKNOWN
Requires-Dist: BeautifulSoup (>=3.2.0)
Requires-Dist: Django (>=1.8)
Requires-Dist: M2Crypto (==0.26.0)
Requires-Dist: structlog

dj-saml-idp
===========

.. image:: https://travis-ci.org/mobify/dj-saml-idp.svg?branch=master
    :target: https://travis-ci.org/mobify/dj-saml-idp


This is a fork `novapost/django-saml2-idp`_ that is distributed indipendantly as `dj-saml-idp`.

`dj-saml-idp` implements the Identity Provider side of the SAML 2.0 protocol
and makes user authentication available to external applications.

**Note:** Only supports Django 1.5+.


Testing 
-------

The test runner is `pytest` and we are using `tox` to run tests against
different versions of Django. The test can be run locally using either `tox`
directly (preferably in a virtualenv)::

    $ pip install tox
    $ tox

Or inside a Docker container using using the provided `Dockerfile` and with 
docker-compose (requires `docker` and `docker-compose` to be installed)::

    $ docker-compose run test-27


Release
-------

First of all, create a new version of the package. We use `bumpversion`_ to
handle updating all version strings, committing the changes and creating a
new git tag automatically. To bump the packag version use the follwoing
command with whichever part of the semantic version you'd like to update::

    $ bumpversion (major|minor|patch)

for instance for a *minor* update, use (which should be the most common case)::

    $ bumpersion minor

You need the PyPI credentials for the `mobify` account to be able to release
a new version and the build script is expecting it defined as an environment
variable::

    $ export PYPI_PASSWORD=supersecretpassword

Releasing a new version to PyPI is very simple. The first thing you need to do
is make sure that all the test are passing and that the version in
`saml2idp/__init__.py` is the one that you'd like to create on PyPI.

With that done, all you need to do is run the following commands::

    $ make release

This will cleanup the `build/` and `dist/` directories, build a source package
and a Python wheel. Both will then be uploaded to PyPI.


License
-------

Distributed under the `MIT License`_.


.. _`novapost/django-saml2-idp`: https://github.com/novapost/django-saml2-idp
.. _`MIT License`: https://github.com/mobify/dj-saml-idp/blob/master/LICENSE
.. _`wheel`: http://wheel.readthedocs.org/en/latest/
.. _`bumpversion`: https://github.com/peritus/bumpversion


.. :changelog:


Release History
---------------


0.22.0 (2016-05-26)
+++++++++++++++++++

* Allow a `redirect_to` parameter to be passed to the logout view to redirect
  the user to after succesful logout instead of showing the logout page.
* Introduce logging through `structlog` and provide more informative logging
  out put to make SAML flows easier to debug. Log messages are all logged under
  the `saml2idp` logger now.
* Adding a new-style processor that carries a `name` attribute which allows
  custom templates for each processor during the SSO process. Custom templates
  are optional and will default to the same templates as before. The change is
  backwards compatible and handles old-style processors as previously.


0.21.2 (2016-04-18)
+++++++++++++++++++


* Switched from `django.utils.importlib` to Python's standard `importlib` to
  work with Django 1.9.
* Update the test setup to run tests against Django 1.9 in addition to all
  other versions of Django.


