Added example .env file.

Author: toddbirchard

README.md

@@ -40,18 +40,20 @@ $ python3 manage.py runserver
 
 ## Configuration
 
-Configuration is handled by creating a **django_views_tutorial/.env** file. This should contain the following variables (replace the values with your own):
+Configuration is handled by creating a **django_views_tutorial/.env** file (see **.env.example** for reference) Replace values with your own:
 
 ```.env
-SECRET_KEY="YOURSECRETKEY"
+DEBUG=True
+SECRET_KEY="yoursecretkey"
 DJANGO_SETTINGS_MODULE="django_views_tutorial.settings"
-DATABASE_ENGINE="django.db.backends.mysql"
-DATABASE_NAME="mydatabasename"
-DATABASE_USER="user"
-DATABASE_PASSWORD="password"
-DATABASE_HOST="mydatabase.mycloud.com"
-DATABASE_PORT=3306
-DATABASE_CERTIFICATE="../creds/ca-certificate.crt" (optional)
+
+DATABASE_ENGINE=django.db.backends.mysql
+DATABASE_NAME=databasename
+DATABASE_USER=username
+DATABASE_PASSWORD=password
+DATABASE_HOST=0.0.0.0
+DATABASE_PORT=1234
+DATABASE_CERTIFICATE="../creds/ca-certificate.crt" # (optional)
 ```
 
 -----

class_views/forms.py

@@ -1,7 +1,9 @@
+"""Form classes."""
 from django import forms
 
 
 class ContactForm(forms.Form):
+    """Email submission form."""
     subject = forms.CharField(required=True, label="Subject line", strip=True)
     email = forms.EmailField(required=True, label="Your email")
     message = forms.CharField(widget=forms.Textarea)

class_views/models.py

@@ -1,3 +1,4 @@
+"""Data models."""
 from django.db import models
 
 

class_views/urls.py

@@ -1,3 +1,4 @@
+"""Class-based view example URLs."""
 from django.conf import settings
 from django.urls import path
 from django.conf.urls.static import static

class_views/views.py

@@ -1,13 +1,12 @@
+"""Examples of class-based views."""
 from datetime import datetime
 
 from django.http import HttpResponseRedirect
 from django.conf import settings
-
 from django.views import View
 from django.views.generic import RedirectView
 from django.views.generic.base import TemplateView
 from django.views.generic.edit import FormView
-
 from django.shortcuts import render, get_object_or_404
 from django.contrib.auth.mixins import PermissionRequiredMixin
 from django.core.mail import send_mail
@@ -17,6 +16,7 @@
 
 
 class GenericClassView(View):
+    """Generic class-based view."""
     initial = {'key': 'value'}
 
     def get(self, request, *args, **kwargs):
@@ -32,6 +32,7 @@ def post(self, request, *args, **kwargs):
 
 
 class TemplateClassView(TemplateView):
+    """Serve a page template."""
     template_name = 'class_views/template_class_view.html'
 
     # change the get method to get_context_data
@@ -44,13 +45,16 @@ def get_context_data(self, **kwargs):
 
 
 class ProtectedClassView(PermissionRequiredMixin, TemplateView):
+    """Serve a page template to authorized users."""
+
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
         context['now'] = datetime.now()
         return context
 
 
 class RedirectClassView(RedirectView):
+    """Permanent redirect view."""
     # https://docs.djangoproject.com/en/3.0/ref/class-based-views/base/#redirectview
     permanent = False
     query_string = True
@@ -63,6 +67,7 @@ def get_redirect_url(self, *args, **kwargs):
 
 
 class ContactView(FormView):
+    """Form-based view."""
     template_name = 'class_views/contact_class_template.html'
     form_class = ContactForm
     success_url = '/success/'

django_views_tutorial/.env.example

@@ -0,0 +1,11 @@
+DEBUG=True
+SECRET_KEY="yoursecretkey"
+DJANGO_SETTINGS_MODULE="django_views_tutorial.settings"
+
+DATABASE_ENGINE=django.db.backends.mysql
+DATABASE_NAME=databasename
+DATABASE_USER=username
+DATABASE_PASSWORD=password
+DATABASE_HOST=0.0.0.0
+DATABASE_PORT=1234
+DATABASE_CERTIFICATE="../creds/ca-certificate.crt"

django_views_tutorial/settings.py

@@ -1,12 +1,12 @@
+"""Django's settings."""
 import os
 import environ
 import mimetypes
 
 mimetypes.add_type("text/css", ".css", True)
 
-root = environ.Path(__file__) - 3  # get root of the project
 env = environ.Env()
-environ.Env.read_env()  # reading .env file
+environ.Env.read_env()
 
 # False if not in os.environ
 DEBUG = env('DEBUG')

function_views/forms.py

@@ -1,13 +1,19 @@
+"""Form classes."""
 from django import forms
 from django.forms import CharField, Textarea
 
 
 class GuestBookForm(forms.Form):
-    name = CharField(label="Your name",
-                     required=True,
-                     strip=True)
-    msg = CharField(label="Leave a message.",
-                    required=True,
-                    widget=Textarea(attrs={'cols': '30', 'rows': '5'}),
-                    min_length=10)
+    """Form to accept guestbook submissions."""
+    name = CharField(
+        label="Your name",
+        required=True,
+        strip=True
+    )
+    msg = CharField(
+        label="Leave a message.",
+        required=True,
+        widget=Textarea(attrs={'cols': '30', 'rows': '5'}),
+        min_length=10
+    )
 

function_views/models.py

@@ -1,8 +1,9 @@
+"""Data models."""
 from django.db import models
 
 
 class User(models.Model):
-    """User account."""
+    """User account model."""
     id = models.AutoField(primary_key=True)
     name = models.CharField(max_length=50)
     email = models.EmailField(null=False)
@@ -17,7 +18,7 @@ class User(models.Model):
 
 
 class Message(models.Model):
-    """Message left by a user in a guest book."""
+    """Guestbook message model."""
     id = models.AutoField(primary_key=True)
     name = models.CharField(max_length=255)
     message = models.TextField()

function_views/urls.py

@@ -1,7 +1,7 @@
+"""Function-based view example URLs."""
 from django.conf import settings
 from django.urls import path
 from django.conf.urls.static import static
-
 from . import views
 
 urlpatterns = [