index.rst

django-browserid

Release v|version|. (:doc:`Quickstart <user/quickstart>`)

django-browserid is a Python library that integrates BrowserID authentication into Django.

BrowserID is an open, decentralized protocol for authenticating users based on email addresses. django-browserid provides the necessary hooks to get Django to authenticate users via BrowserID. By default, django-browserid relies on Persona for the client-side JavaScript shim and for assertion verification.

django-browserid is tested on Python 2.7 and 3.2 onward, and supports Django 1.7 and up. See tox.ini for more details.

django-browserid depends on:

• Requests >= 1.0.0
• jQuery >= 1.8 (if you are using api.js and browserid.js).

django-browserid is a work in progress. Contributions are welcome. Feel free to fork and contribute!

User Guide

.. toctree::
   :maxdepth: 2

   user/intro
   user/quickstart
   user/customization
   user/extras
   user/settings
   user/deploying
   user/upgrading
   user/troubleshooting

API Documentation

.. toctree::
   :maxdepth: 2

   api/python
   api/javascript

Contributor Guide

.. toctree::
   :maxdepth: 1

   contributor/setup
   contributor/guidelines
   contributor/changelog
   contributor/authors