/docs/overview.rst

Overview
========

Requirements
------------

- Python 2.7, 3.2, 3.3, 3.4, or 3.5

- Django (1.4.3+)

- python-openid or python3-openid (depending on your Python version)

- requests and requests-oauthlib

Supported Flows
---------------

- Signup of both local and social accounts

- Connecting more than one social account to a local account

- Disconnecting a social account -- requires setting a password if
  only the local account remains

- Optional instant-signup for social accounts -- no questions asked

- E-mail address management (multiple e-mail addresses, setting a primary)

- Password forgotten flow

- E-mail address verification flow

Supported Providers
-------------------

- 23andMe (OAuth2)

- Amazon (OAuth2)

- AngelList (OAuth2)

- Asana (OAuth2)

- Basecamp (OAuth2)

- Baidu (OAuth2)

- Battle.net (OAuth2)

- Bitbucket (OAuth, OAuth2)

- Bitly (OAuth2)

- Douban (OAuth2)

- Dropbox (OAuth, OAuth2)

- Edmodo (OAuth2)

- Eve Online (OAuth2)

- Evernote (OAuth)

- Facebook (both OAuth2 and JS SDK)

- Feedly (OAuth2)

- Firefox Accounts (OAuth2)

- Flickr (OAuth)

- Github (OAuth2)

- GitLab (OAuth2)

- Google (OAuth2)

- Hubic (OAuth2)

- Instagram (OAuth2)

- LinkedIn (OAuth, OAuth2)

- Mail.Ru (OAuth2)

- Odnoklassniki (OAuth2)

- OpenId

- ORCID (OAuth2)

- Paypal (OAuth2)

- Persona

- Pinterest (OAuth2)

- Reddit (OAuth2)

- Shopify (OAuth2)

- Slack (OAuth2)

- SoundCloud (OAuth2)

- Spotify (OAuth2)

- Stack Exchange (OAuth2)

- Stripe (OAuth2)

- Tumblr (OAuth)

- Twitch (OAuth2)

- Twitter (OAuth)

- Untappd (OAuth2)

- Vimeo (OAuth)

- VK (OAuth2)

- Weibo (OAuth2)

- Weixin (OAuth2)

- Windows Live (OAuth2)

- Xing (OAuth)


Note: OAuth/OAuth2 support is built using a common code base, making it easy to add support for additional OAuth/OAuth2 providers. More will follow soon...


Features
--------

- Supports multiple authentication schemes (e.g. login by user name,
  or by e-mail), as well as multiple strategies for account
  verification (ranging from none to e-mail verification).

- All access tokens are consistently stored so that you can publish
  wall updates etc.

Architecture & Design
---------------------

- Pluggable signup form for asking additional questions during signup.

- Support for connecting multiple social accounts to a Django user account.

- The required consumer keys and secrets for interacting with
  Facebook, Twitter and the likes are to be configured in the database
  via the Django admin using the SocialApp model.

- Consumer keys, tokens make use of the Django sites framework. This
  is especially helpful for larger multi-domain projects, but also
  allows for for easy switching between a development (localhost) and
  production setup without messing with your settings and database.