django-allauth-ens 1.0.0b2

Installation

First, install django-allauth.

Then, install django-allauth-ens:

$ pip install django-allauth-ens

And edit your settings file:

INSTALLED_APPS = [
    # …

    # Above allauth to replace its templates.
    'allauth_ens',

    # Added when you installed allauth.
    'allauth',
    'allauth.account',
    'allauth.socialaccount',

    # Required to use CAS-based providers (e.g. Clipper).
    'allauth_cas',

    # …
]

Configuration

See also the allauth configuration and advanced usage docs pages.

ACCOUNT_HOME_URL

Optional — A view name or an url path.

Used as a link from the templates of allauth_ens to return to your application.

Examples: 'home', '/home/'

ACCOUNT_DETAILS_URL

Optional — A view name or an url path.

Used as a link from the templates of allauth_ens for a logged in user to access their profile in your app.

Examples: 'my-account', '/my-account/'

Views

Capture other login and logout views

You can use the capture_login and capture_logout views to replace the login and logout views of other applications. They redirect to their similar allauth’s view and forward the query string, so that if a GET parameter next is given along the initial request, user is redirected to this url on successful login and logout.

This requires to add urls before the include of the app’ urls.

For example, to replace the Django admin login and logout views with allauth’s ones:

from allauth_ens.views import capture_login, capture_logout

urlpatterns = [
    # …

    # Add it before include of admin urls.
    url(r'^admin/login/$', capture_login),
    url(r'^admin/logout/$', capture_logout),

    url(r'^admin/$', include(admin.site.urls)),

    # …
]

Templates

The templates provided by allauth only contains the bare minimum. Hopefully, this package includes ready-to-use templates. They are automatically used if you put 'allauth_ens' before 'allauth' in your INSTALLED_APPS,

Providers

Google, Facebook¸ but also Clipper…

To interact with an external authentication service, you must add the corresponding provider application to your INSTALLED_APPS.

allauth already includes several providers (see also their python path). In addition to that, this package adds the following providers:

Demo Site

See example/README.

Development

First, you need to clone the repository.

Howtos

Assuming you use the following settings (when needed):

ACCOUNT_ADAPTER = 'shared.allauth_adapter.AccountAdapter'
SOCIALACCOUNT_ADAPTER = 'shared.allauth_adapter.SocialAccountAdapter'

class AccountAdapter(DefaultAccountAdapter):
    def is_open_for_signup(self, request):
        return False

class SocialAccountAdapter(DefaultSocialAccountAdapter):
    def is_open_for_signup(self, request, sociallogin):
        # sociallogin.account is a SocialAccount instance.
        # See https://github.com/pennersr/django-allauth/blob/master/allauth/socialaccount/models.py

        if sociallogin.account.provider == 'clipper':
            return True

        # It returns AccountAdapter.is_open_for_signup().
        # See https://github.com/pennersr/django-allauth/blob/master/allauth/socialaccount/adapter.py
        return super().is_open_for_signup(request, sociallogin)