Metadata-Version: 2.1
Name: django-user-login
Version: 0.2.2
Summary: A django user authentication and login application.
Home-page: https://github.com/prayagsrivastava/django-user-login
Author: Prayag Srivastava
Author-email: prayag.srivastava@outlook.com
Project-URL: Bug Tracker, https://github.com/prayagsrivastava/django-user-login/issues
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# Authentication
A django user authentication and login application.

### 1.  To install and use the package, use:
        
        pip install django-user-login

Instructions

### 2.	Add "authentication" to your INSTALLED_APPS setting like this:

        INSTALLED_APPS = [
            ...
            'authentication',
        ]

### 3.	The App requires [Django Sessions](https://docs.djangoproject.com/en/4.0/topics/http/sessions/#enabling-sessions)

### 4.	Include the authentication URLconf in your project urls.py like this:

		path('authentication/', include('authentication.urls')),

### 5.	Run `python manage.py migrate` to create the User models (you'll need the Admin app enabled).

### 6.  In your settings.py file include the following:

        SITE_TITLE = 'your site title'
        LOGIN_URL = '/authentication/'
        EMAIL_HOST = 'email-host'
        EMAIL_PORT = email-port
        EMAIL_HOST_USER = 'email-address'
        EMAIL_HOST_PASSWORD = 'email-password'
        EMAIL_USE_TLS = True
        
        # set this to True if you want the app's default favicon
        DEFAULT_APP_FAVICON_ICO = False

### 8.  For login and logout functionality, use - 
- #### To Login, use anyone of these

            - <a href="{% url 'authentication:login' %}">Login</a>
		    - <a href='/authentication/'>Login</a>

- #### To Logout, use anyone of these

            - <a href="{% url 'authentication:logout' %}">Logout</a>
		    - <a href="/authentication/logout/">Logout</a>

- #### To visit My Account page and edit profile credentials, use any one of these -

            - <a href="{% url 'authentication:account' username=request.user.username %}">Account</a>
            - <a href="/authentication/<username>/">Account</a>

### 9. This app uses Bootstrap, Bootstrap Icons, JQuery and Handlebars. These file can be accessed at -

            <link href="{% static 'authentication/assets/node_modules/bootstrap/dist/css/bootstrap.css' %}" rel="stylesheet">
            <link href="{% static 'authentication/assets/node_modules/bootstrap-icons/font/bootstrap-icons.css' %}" rel="stylesheet">

            <script src="{% static 'authentication/assets/node_modules/bootstrap/dist/js/bootstrap.bundle.js' %}"></script>
            <script src="{% static 'authentication/assets/node_modules/jquery/dist/jquery.js' %}"></script>
            <script src="{% static 'authentication/assets/node_modules/handlebars/dist/handlebars.js' %}"></script>


### 10. Check [Demo Website](https://django-user-login.herokuapp.com/)

### 11. Actual EMAILS will not be sent when DEBUG = TRUE

            Verification Codes, if any, will be printed on the console


