Merge pull request #618 from realpython/django-user-management

Add Django User Management files

django-user-management/README.md

@@ -0,0 +1,46 @@
+# Get Started With Django User Management
+
+Follow the [step-by-step instructions](https://realpython.com/django-user-management/) on Real Python.
+
+## Setup
+
+You can run the provided example project on your local machine by following the steps outlined below.
+
+Create a new virtual environment:
+
+```bash
+$ python3 -m venv venv/
+```
+
+Activate the virtual environment:
+
+```bash
+$ source venv/bin/activate
+```
+
+Install the dependencies for this project if you haven't installed them yet:
+
+```bash
+(venv) $ python -m pip install -r requirements.txt
+```
+
+Navigate into the project's directory:
+
+```bash
+(venv) $ cd user_auth_intro/
+```
+
+Make and apply the migrations for the project to build your local database:
+
+```bash
+(venv) $ python manage.py makemigrations
+(venv) $ python manage.py migrate
+```
+
+Run the Django development server:
+
+```bash
+(venv) $ python manage.py runserver
+```
+
+Navigate to `http://localhost:8000/dashboard` to see the project in action.

django-user-management/requirements.txt

@@ -0,0 +1,3 @@
+asgiref==3.8.1
+Django==5.1.3
+sqlparse==0.5.2

django-user-management/user_auth_intro/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "user_auth_intro.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

django-user-management/user_auth_intro/user_auth_intro/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for user_auth_intro project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.1/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "user_auth_intro.settings")
+
+application = get_asgi_application()

django-user-management/user_auth_intro/user_auth_intro/settings.py

@@ -0,0 +1,128 @@
+"""
+Django settings for user_auth_intro project.
+
+Generated by 'django-admin startproject' using Django 5.1.3.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.1/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/5.1/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/5.1/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = (
+    "django-insecure-%&$tji0geb7vpx8@9-&qbf3_%3$s=5*5amo4tr)yg!6&6@bbhl"
+)
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    "users.apps.UsersConfig",
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+]
+
+ROOT_URLCONF = "user_auth_intro.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "user_auth_intro.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/5.1/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/5.1/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/5.1/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/5.1/howto/static-files/
+
+STATIC_URL = "static/"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/5.1/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

django-user-management/user_auth_intro/user_auth_intro/urls.py

@@ -0,0 +1,7 @@
+from django.contrib import admin
+from django.urls import include, path
+
+urlpatterns = [
+    path("", include("users.urls")),
+    path("admin/", admin.site.urls),
+]

django-user-management/user_auth_intro/user_auth_intro/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for user_auth_intro project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.1/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "user_auth_intro.settings")
+
+application = get_wsgi_application()

django-user-management/user_auth_intro/users/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class UsersConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "users"

django-user-management/user_auth_intro/users/forms.py

@@ -0,0 +1,6 @@
+from django.contrib.auth.forms import UserCreationForm
+
+
+class CustomUserCreationForm(UserCreationForm):
+    class Meta(UserCreationForm.Meta):
+        fields = UserCreationForm.Meta.fields + ("email",)

django-user-management/user_auth_intro/users/templates/base.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>User Management Intro</title>
+  </head>
+  <body>
+    <h1>Welcome!</h1>
+    {% block content %}
+    {% endblock content %}
+  </body>
+</html>

django-user-management/user_auth_intro/users/templates/registration/_logout.html

@@ -0,0 +1,6 @@
+<form method="post" action="{% url 'logout' %}">
+    {% csrf_token %}
+    {{ form.as_p }}
+    <input type="submit" value="Logout" />
+    <input type="hidden" name="next" value="{% url 'dashboard' %}" />
+</form>

django-user-management/user_auth_intro/users/templates/registration/login.html

@@ -0,0 +1,14 @@
+{% extends "base.html" %}
+{% block content %}
+    <h2>Login</h2>
+    <form method="post">
+        {% csrf_token %}
+        {{ form.as_p }}
+        <input type="submit" value="Login" />
+        <input type="hidden" name="next" value="{% url 'dashboard' %}" />
+    </form>
+    <p>
+        <a href="{% url 'password_reset' %}">Forgot your password?</a>
+        <a href="{% url 'dashboard' %}">Back to dashboard</a>
+    </p>
+{% endblock content %}

django-user-management/user_auth_intro/users/templates/registration/password_change_done.html

@@ -0,0 +1,5 @@
+{% extends "base.html" %}
+{% block content %}
+    <h2>Password changed</h2>
+    <a href="{% url 'dashboard' %}">Back to dashboard</a>
+{% endblock content %}

django-user-management/user_auth_intro/users/templates/registration/password_change_form.html

@@ -0,0 +1,10 @@
+{% extends "base.html" %}
+{% block content %}
+    <h2>Change password</h2>
+    <form method="post">
+        {% csrf_token %}
+        {{ form.as_p }}
+        <input type="submit" value="Change" />
+    </form>
+    <a href="{% url 'dashboard' %}">Back to dashboard</a>
+{% endblock content %}

django-user-management/user_auth_intro/users/templates/registration/password_reset_complete.html

@@ -0,0 +1,5 @@
+{% extends "base.html" %}
+{% block content %}
+    <h2>Password reset completed</h2>
+    <a href="{% url 'login' %}">Login</a>
+{% endblock content %}

django-user-management/user_auth_intro/users/templates/registration/password_reset_confirm.html

@@ -0,0 +1,10 @@
+{% extends "base.html" %}
+{% block content %}
+    <h2>Confirm password reset</h2>
+    <form method="post">
+        {% csrf_token %}
+        {{ form.as_p }}
+        <input type="submit" value="Confirm" />
+    </form>
+    <a href="{% url 'dashboard' %}">Back to dashboard</a>
+{% endblock content %}

django-user-management/user_auth_intro/users/templates/registration/password_reset_done.html

@@ -0,0 +1,5 @@
+{% extends "base.html" %}
+{% block content %}
+    <h2>Password reset link sent</h2>
+    <a href="{% url 'dashboard' %}">Back to dashboard</a>
+{% endblock content %}

django-user-management/user_auth_intro/users/templates/registration/password_reset_form.html

@@ -0,0 +1,12 @@
+{% extends "base.html" %}
+{% block content %}
+    <h2>Send password reset link</h2>
+    <form method="post">
+        {% csrf_token %}
+        {{ form.as_p }}
+        <input type="submit" value="Send Reset Link" />
+    </form>
+    <p>
+        <a href="{% url 'dashboard' %}">Back to dashboard</a>
+    </p>
+{% endblock content %}

django-user-management/user_auth_intro/users/templates/registration/sign_up.html

@@ -0,0 +1,12 @@
+{% extends "base.html" %}
+{% block content %}
+    <h2>Sign Up</h2>
+    <form method="post">
+        {% csrf_token %}
+        {{ form.as_p }}
+        <input type="submit" value="Sign Up" />
+    </form>
+    <p>
+        <a href="{% url 'dashboard' %}">Back to dashboard</a>
+    </p>
+{% endblock content %}

django-user-management/user_auth_intro/users/templates/users/dashboard.html

@@ -0,0 +1,12 @@
+{% extends "base.html" %}
+{% block content %}
+    Hello, {{ user.username|default:"Guest" }}!
+    <hr />
+    {% if user.is_authenticated %}
+        {% include "registration/_logout.html" %}
+        <a href="{% url 'password_change' %}">Change password</a>
+    {% else %}
+        <a href="{% url 'login' %}">Login</a>
+        <a href="{% url 'sign_up' %}">Sign up</a>
+    {% endif %}
+{% endblock content %}

django-user-management/user_auth_intro/users/urls.py

@@ -0,0 +1,9 @@
+from django.urls import include, path
+
+from . import views
+
+urlpatterns = [
+    path("accounts/", include("django.contrib.auth.urls")),
+    path("dashboard/", views.dashboard, name="dashboard"),
+    path("sign_up/", views.sign_up, name="sign_up"),
+]