Metadata-Version: 2.1
Name: django-drf-auth
Version: 0.1
Summary: REST API endpoints for Authentication and Registration
Home-page: https://github.com/thomas545/django-drf-auth/
Author: Thomas Adel
Author-email: thomas.adel31@gmail.com
License: MIT
Description: # DRF Authentication
        
        ### Quickstart
        For installing django-drf-auth, just run this command in your shell
        
        ```
        pip install django-drf-auth
        ```
        
        ### settings
        ```
        INSTALLED_APPS = (
            # ...
            'django.contrib.sites',
            'rest_auth',
            'allauth',
            'allauth.account',
            'rest_auth.registration',
            'drf_auth',
        )
        
        
        FRONT_URL = '' 
        EMAIL_HOST_USER = '' 
        EMAIL_HOST_PASSWORD = '' 
        EMAIL_PORT = 587 
        
        REST_USE_JWT = True
        SITE_ID = 1
        
        ACCOUNT_EMAIL_VERIFICATION = 'mandatory'
        ACCOUNT_EMAIL_REQUIRED = True
        
        ```
        FRONT_URL -> this is your url `` https://www.example.com ``
        
        
        ### URLS
        
        ```
        urlpatterns = [
            # ...
            path('drf_auth/', include('drf_auth.urls')),
        ]
        ```
        
        
        
        
        
        
        
        
        #### API Endpoints: 
        
        ##### Register
        Method: `POST`  
        Endpoint: `/registration/`  
        Payload:  
        `{  
            "username": "USERNAME",  
            "password1": "PASSWORD",  
            "password2": "PASSWORD",  
            "email": "EMAIL"  
        }`
        
        ##### Register Confirm Email
        Method: `POST`  
        Endpoint: `/account-confirm-email/<str:key>/`  
        Payload:  
        `{  
            "key": "KEY",
        }`
        
        
        ##### Login
        Method: `POST`  
        Endpoint: `/login/`  
        Payload:  
        `{  
            "username": "USERNAME",  
            "password": "PASSWORD"  
        }`
        
        ##### Logout
        Method: `POST`  
        Endpoint: `/logout/`  
        Headers: `Authorization: JWT YOUR_TOKEN_HERE`  
        
        ##### Change Password
        Method: `POST`  
        Endpoint: `/password/change/`  
        Payload:  
        `{  
            "old_password": "OLD PASSWORD",  
            "new_password1": "NEW PASSWORD1",
            "new_password2": "NEW PASSWORD2"  
        }`
        
        ##### Reset Password
        Method: `POST`  
        Endpoint: `/password/reset/`  
        Payload:  
        `{  
            "email": "EMAIL ADDRESS",  
        
        }`
        
        ##### Reset Password Confirm
        Method: `POST`  
        Endpoint: `/password/reset/confirm/<str:uid>/<str:token>/`  
        Payload:  
        `{  
            "uid": "UID",  
            "token": "token",  
        
        }`
        
        ##### Reset Password Confirm
        Method: `GET`  
        Endpoint: `/user/`  
        Headers: `Authorization: JWT YOUR_TOKEN_HERE`  
        
        
        ## Contributing
        Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
        Please make sure to update tests as appropriate.
        
        ## License
        MIT
Keywords: django drf auth rest-framework-authentication api
Platform: UNKNOWN
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development
Description-Content-Type: text/markdown
