Metadata-Version: 2.1
Name: django_toyo_auth
Version: 0.2.0
Summary: It offers providers of Toyo University and INIAD Accounts for django-allauth
Home-page: http://github.com/ayame-q/django-toyo-auth
Author: ayame.space
Author-email: ayame.space@gmail.com
License: MIT
Description: "Django Toyo Auth" offers providers of Toyo University Accounts(@toyo.jp) and INIAD Accounts(@iniad.org) for [django-allauth](https://django-allauth.readthedocs.io/en/latest/index.html)
        
        
        ## Installation
        ### Install Package
        ```bash
        pip install django-toyo-auth
        ```
        
        ### settings.py
        ```python
        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
        ```python
        urlpatterns = [
            ...
            path('accounts/', include('allauth.urls')),
            ...
        ]
        ```
        
        ## Classes
        ### django_toyo_auth.models.AbstractUser
        User class with student_id, entry_year, is_student
        #### Attributes
        * student_id
        * entry_year
        * is_student
        
        #### methods
        * get_school_year() => int
        
        ### django_toyo_auth.models.UUIDAbstractUser
        Inherits all attributes and methods from [AbstractUser](django_toyo_auth.models.AbstractUser), 
        but also primary_key is UUID
        #### Attributes
        * uuid
        
        
        ## Details
        It offers only providers and custom models for django-allauth.
        Please see [django-allauth documents](https://django-allauth.readthedocs.io/en/latest/index.html) for detail
        
        ## Requirements
        * [Django](https://docs.djangoproject.com/)
        * [django-allauth](https://django-allauth.readthedocs.io/en/latest/index.html)
        
        ## Licenses
        MIT
Keywords: django-allauth,django,INIAD,Toyo Univ,東洋大学
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Django :: 3.2
Classifier: Topic :: Education
Classifier: Topic :: System :: Systems Administration :: Authentication/Directory
Description-Content-Type: text/markdown
