Metadata-Version: 2.1
Name: django-phone-auth
Version: 0.1
Summary: A Django app to authenticate and register user using phone/email/username.
Home-page: https://github.com/samyakjain101/django-phone-auth
Author: Samyak Jain
Author-email: samyakjain101@gmail.com
License: MIT License
Description: # django-phone-auth
        A Django app to authenticate and register user using phone/email/username. It uses
        default User Model.
        
        ## Installation
        ```
        pip install django-phone-auth
        ```
        
        Add 'phone_auth' in INSTALLED_APPS.
        
        ```
        INSTALLED_APPS = [
            ...
            'phone_auth'
        ]
        ```
        
        Add 'phone_auth.backend.CustomAuthBackend' in AUTHENTICATION_BACKENDS.
        
        ```
        AUTHENTICATION_BACKENDS = [
            'django.contrib.auth.backends.ModelBackend',
            ...
            'phone_auth.backend.CustomAuthBackend',
        ]
        ```
        
        Add 'path('accounts/', include('phone_auth.urls'))' in urls.py
        
        ```
        urlpatterns = [
            ...
            path('accounts/', include('phone_auth.urls'))
        ]
        ```
        
        Now run command -
        
        ```
        python manage.py migrate
        ```
        
        ## Usage
        
        On registration page ('accounts/register/') by default
        first_name, last_name, email and username is optional.
        These can be set to required by adding following variables
        in settings.py
        
        ```
        REGISTER_USERNAME_REQUIRED = True
        REGISTER_EMAIL_REQUIRED = True
        REGISTER_FNAME_REQUIRED = True
        REGISTER_LNAME_REQUIRED = True
        
        ```
        
        On login page ('accounts/login/') by default user can only
        login with phone. To allow login through username/email/phone
        add following in settings.py
        ```
        LOGIN_METHODS = {'email', 'phone', 'username'}
        ```
        
        Note: LOGIN_METHODS can't be empty
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Description-Content-Type: text/markdown
