Merge pull request #142 from realpython/django-auth-views

jaschmitt · web-flow · commit 4516618865ac · 2020-10-14T13:33:11.000-07:00
Sample code for django-view-auth
diff --git a/django-view-auth/.gitignore b/django-view-auth/.gitignore
@@ -0,0 +1,27 @@
+# git ls-files --others --exclude-from=.git/info/exclude
+# Lines that start with '#' are comments.
+# For a project mostly in C, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~
+.DS_Store
+*.pyc
+*.o
+*.so
+*.swp
+*~
+.coverage*
+htmlcov/
+foo.py
+debug.log
+db.sqlite3
+logs/*
+*.egg
+*.eggs
+*.egg-info
+build/
+dist/
+docs/_build/
+extras/sample_site/uploads/
+extras/sample_site/db.sqlite3
+.tox/
diff --git a/django-view-auth/Blog/Blog/__init__.py b/django-view-auth/Blog/Blog/__init__.py
diff --git a/django-view-auth/Blog/Blog/asgi.py b/django-view-auth/Blog/Blog/asgi.py
@@ -0,0 +1,16 @@
+"""
+ASGI config for Blog 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/3.0/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "Blog.settings")
+
+application = get_asgi_application()
diff --git a/django-view-auth/Blog/Blog/settings.py b/django-view-auth/Blog/Blog/settings.py
@@ -0,0 +1,108 @@
+"""
+Django settings for Blog project.
+
+Generated by 'django-admin startproject' using Django 3.0.7.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.0/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/3.0/ref/settings/
+"""
+
+import os
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/3.0/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "9p2cpl%!f8a0tptz_85&dulu&!_ve=j_0s6-l4=tc-g!p-$whj"
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "core",
+]
+
+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 = "Blog.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [os.path.join(BASE_DIR, "templates")],
+        "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 = "Blog.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/3.0/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": os.path.join(BASE_DIR, "db.sqlite3"),
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/3.0/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = []
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/3.0/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/3.0/howto/static-files/
+
+STATIC_URL = "/static/"
diff --git a/django-view-auth/Blog/Blog/urls.py b/django-view-auth/Blog/Blog/urls.py
@@ -0,0 +1,15 @@
+from django.contrib import admin
+from django.urls import path, include
+from core import views as core_views
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+    path("", core_views.listing, name="listing"),
+    path("view_blog/<int:blog_id>/", core_views.view_blog, name="view_blog"),
+    path("see_request/", core_views.see_request),
+    path("user_info/", core_views.user_info),
+    path("private_place/", core_views.private_place),
+    path("accounts/", include("django.contrib.auth.urls")),
+    path("staff_place/", core_views.staff_place),
+    path("add_messages/", core_views.add_messages),
+]
diff --git a/django-view-auth/Blog/Blog/wsgi.py b/django-view-auth/Blog/Blog/wsgi.py
@@ -0,0 +1,16 @@
+"""
+WSGI config for Blog 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/3.0/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "Blog.settings")
+
+application = get_wsgi_application()
diff --git a/django-view-auth/Blog/core/__init__.py b/django-view-auth/Blog/core/__init__.py
diff --git a/django-view-auth/Blog/core/admin.py b/django-view-auth/Blog/core/admin.py
@@ -0,0 +1,7 @@
+from django.contrib import admin
+from core.models import Blog
+
+
+@admin.register(Blog)
+class BlogAdmin(admin.ModelAdmin):
+    pass
diff --git a/django-view-auth/Blog/core/apps.py b/django-view-auth/Blog/core/apps.py
@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class CoreConfig(AppConfig):
+    name = "core"
diff --git a/django-view-auth/Blog/core/fixtures/core.json b/django-view-auth/Blog/core/fixtures/core.json
@@ -0,0 +1 @@
+[{"model": "core.blog", "pk": 1, "fields": {"title": "Fruit", "content": "<p> Turns out, you can compare them: </p>\r\n\r\n<ul>\r\n   <li>Apple</li>\r\n   <li>Orange</li>\r\n</ul>"}}, {"model": "core.blog", "pk": 2, "fields": {"title": "I like airplanes", "content": "I prefer them to be very <i>fast</i>. I wish the Concorde still existed."}}]
diff --git a/django-view-auth/Blog/core/migrations/0001_initial.py b/django-view-auth/Blog/core/migrations/0001_initial.py
@@ -0,0 +1,29 @@
+# Generated by Django 3.0.7 on 2020-07-31 15:14
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="Blog",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("title", models.CharField(max_length=50)),
+                ("content", models.TextField()),
+            ],
+        ),
+    ]
diff --git a/django-view-auth/Blog/core/migrations/__init__.py b/django-view-auth/Blog/core/migrations/__init__.py
diff --git a/django-view-auth/Blog/core/models.py b/django-view-auth/Blog/core/models.py
@@ -0,0 +1,6 @@
+from django.db import models
+
+
+class Blog(models.Model):
+    title = models.CharField(max_length=50)
+    content = models.TextField()
diff --git a/django-view-auth/Blog/core/views.py b/django-view-auth/Blog/core/views.py
@@ -0,0 +1,69 @@
+from django.contrib import messages
+from django.contrib.auth.decorators import login_required, user_passes_test
+from django.http import HttpResponse
+from django.shortcuts import render, get_object_or_404
+from core.models import Blog
+
+
+def listing(request):
+    data = {
+        "blogs": Blog.objects.all(),
+    }
+
+    return render(request, "listing.html", data)
+
+
+def view_blog(request, blog_id):
+    blog = get_object_or_404(Blog, id=blog_id)
+    data = {
+        "blog": blog,
+    }
+
+    return render(request, "view_blog.html", data)
+
+
+def see_request(request):
+    text = f"""
+        Some attributes of the HttpRequest object:
+
+        scheme: {request.scheme}
+        path:   {request.path}
+        method: {request.method}
+        GET: {request.GET}
+        user: {request.user}
+    """
+
+    return HttpResponse(text, content_type="text/plain")
+
+
+def user_info(request):
+    text = f"""
+        Selected HttpRequest.user attributes:
+
+        username:     {request.user.username}
+        is_anonymous: {request.user.is_anonymous}
+        is_staff:     {request.user.is_staff}
+        is_superuser: {request.user.is_superuser}
+        is_active:    {request.user.is_active}
+    """
+
+    return HttpResponse(text, content_type="text/plain")
+
+
+@login_required
+def private_place(request):
+    return HttpResponse("Shhh, members only!", content_type="text/plain")
+
+
+@user_passes_test(lambda user: user.is_staff)
+def staff_place(request):
+    return HttpResponse("Employees must wash hands", content_type="text/plain")
+
+
+@login_required
+def add_messages(request):
+    username = request.user.username
+    messages.add_message(request, messages.INFO, f"Hello {username}")
+    messages.add_message(request, messages.WARNING, "DANGER WILL ROBINSON")
+
+    return HttpResponse("Messages added", content_type="text/plain")
diff --git a/django-view-auth/Blog/db.sqlite3 b/django-view-auth/Blog/db.sqlite3
diff --git a/django-view-auth/Blog/manage.py b/django-view-auth/Blog/manage.py
@@ -0,0 +1,21 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "Blog.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()
diff --git a/django-view-auth/Blog/pyflakes.sh b/django-view-auth/Blog/pyflakes.sh
@@ -0,0 +1,5 @@
+#!/bin/bash
+
+echo "============================================================"
+echo "== pyflakes =="
+pyflakes core | grep -v migration
diff --git a/django-view-auth/Blog/resetdb.sh b/django-view-auth/Blog/resetdb.sh
@@ -0,0 +1,8 @@
+#!/bin/bash
+
+find . -name "*.pyc" -exec rm {} \;
+rm db.sqlite3
+
+python manage.py makemigrations core
+python manage.py migrate
+python manage.py loaddata core
diff --git a/django-view-auth/Blog/runserver.sh b/django-view-auth/Blog/runserver.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+python manage.py runserver
diff --git a/django-view-auth/Blog/templates/base.html b/django-view-auth/Blog/templates/base.html
@@ -0,0 +1,8 @@
+<html>
+<body>
+
+{% block content %}
+{% endblock content %}
+
+</body>
+</html>
diff --git a/django-view-auth/Blog/templates/listing.html b/django-view-auth/Blog/templates/listing.html
@@ -0,0 +1,21 @@
+{% extends "base.html" %}
+
+{% block content %}
+<h1>Blog Listing</h1>
+
+{% if messages %}
+<ul class="messages" style="background-color:#ccc">
+  {% for message in messages %}
+    <li {% if message.tags %} class="{{ message.tags }}" {% endif %}>
+      {{ message }}
+    </li>
+  {% endfor %}
+</ul>
+{% endif %}
+
+<ul>
+{% for blog in blogs %}
+  <li> <a href="{% url 'view_blog' blog.id %}">{{blog.title}}</a> </li>
+{% endfor %}
+</ul>
+{% endblock content %}
diff --git a/django-view-auth/Blog/templates/registration/login.html b/django-view-auth/Blog/templates/registration/login.html
@@ -0,0 +1,13 @@
+{% extends 'base.html' %}
+
+{% block content %}
+<h1>Login</h1>
+
+<form method="post">
+    {% csrf_token %}
+    {{ form.as_p }}
+    <input type="submit" value="Login">
+</form>
+
+<a href="{% url 'listing' %}">All Blogs</a>
+{% endblock %}
diff --git a/django-view-auth/Blog/templates/view_blog.html b/django-view-auth/Blog/templates/view_blog.html

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+[{"model": "core.blog", "pk": 1, "fields": {"title": "Fruit", "content": "<p> Turns out, you can compare them: </p>\r\n\r\n<ul>\r\n <li>Apple</li>\r\n <li>Orange</li>\r\n</ul>"}}, {"model": "core.blog", "pk": 2, "fields": {"title": "I like airplanes", "content": "I prefer them to be very <i>fast</i>. I wish the Concorde still existed."}}]`