Skip to content

ayame-q/django-toyo-auth

Repository files navigation

Django Toyo Auth

"Django Toyo Auth" offers providers of Toyo University Accounts(@toyo.jp) and INIAD Accounts(@iniad.org) for django-allauth

Installation

Install Package

pip install django-toyo-auth

settings.py

INSTALLED_APPS = [
    ...
    'django.contrib.auth',
    'django.contrib.messages',
    'django.contrib.sites',
    'allauth',
    'allauth.account',
    'allauth.socialaccount',
    'django_toyo_auth',
    'django_toyo_auth.providers.iniad', # INIAD Account
    'django_toyo_auth.providers.toyo', # Toyo Account
    ...
]

SITE_ID = 1

# Provider specific settings
SOCIALACCOUNT_PROVIDERS = {
    'iniad': { # for INIAD Account
        'SCOPE': [
            'profile',
            'email',
        ],
        'AUTH_PARAMS': {
            'access_type': 'online',
        },
    },
    'toyo': { # for Toyo Account
        'SCOPE': [
            'profile',
            'email',
        ],
        'AUTH_PARAMS': {
            'access_type': 'online',
        },
    },
}

urls.py

urlpatterns = [
    ...
    path('accounts/', include('allauth.urls')),
    ...
]

Classes

django_toyo_auth.models.AbstractUser

User class with student_id, entry_year, is_student, is_toyo_member, is_iniad_member

Attributes

  • student_id
  • entry_year
  • is_student
  • is_toyo_member
  • is_iniad_member
  • grade

django_toyo_auth.models.UUIDAbstractUser

Inherits all attributes and methods from AbstractUser, but also primary_key is UUID

Attributes

  • uuid

django_toyo_auth.admin.ToyoUserAdmin

ModelAdmin class for AbstractUser. It offers user-friendly admin pages.

django_toyo_auth.admin.UUIDToyoUserAdmin

ModelAdmin class for UUIDAbstractUser. It offers user-friendly admin pages.

Details

It offers only providers and custom models for django-allauth. Please see django-allauth documents for detail

Requirements

License

MIT