Add documentation and source

Added documentation, source and extra files.

source/forms/.idea/Forms.iml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+  <component name="FacetManager">
+    <facet type="django" name="Django">
+      <configuration>
+        <option name="rootFolder" value="$MODULE_DIR$" />
+        <option name="settingsModule" value="forms/settings.py" />
+        <option name="manageScript" value="manage.py" />
+        <option name="environment" value="&lt;map/&gt;" />
+        <option name="doNotUseTestRunner" value="false" />
+        <option name="trackFilePattern" value="" />
+      </configuration>
+    </facet>
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$" isTestSource="false" />
+      <excludeFolder url="file://$MODULE_DIR$/.idea" />
+    </content>
+    <orderEntry type="jdk" jdkName="Python 3 (training)" jdkType="Python SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+  <component name="PackageRequirementsSettings">
+    <option name="requirementsPath" value="$MODULE_DIR$/../../requirements.pip" />
+  </component>
+  <component name="PyDocumentationSettings">
+    <option name="format" value="GOOGLE" />
+    <option name="myDocStringFormat" value="Google" />
+  </component>
+  <component name="TemplatesService">
+    <option name="TEMPLATE_CONFIGURATION" value="Django" />
+  </component>
+</module>

source/forms/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,12 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="GrazieInspection" enabled="false" level="TYPO" enabled_by_default="false" />
+    <inspection_tool class="LanguageDetectionInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SpellCheckingInspection" enabled="false" level="TYPO" enabled_by_default="false">
+      <option name="processCode" value="true" />
+      <option name="processLiterals" value="true" />
+      <option name="processComments" value="true" />
+    </inspection_tool>
+  </profile>
+</component>

source/forms/.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="USE_PROJECT_PROFILE" value="false" />
+    <version value="1.0" />
+  </settings>
+</component>

source/forms/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/forms.iml" filepath="$PROJECT_DIR$/.idea/forms.iml" />
+    </modules>
+  </component>
+</project>

source/forms/.idea/workspace.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectViewState">
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showExcludedFiles" value="false" />
+    <option name="showLibraryContents" value="true" />
+  </component>
+</project>

source/forms/demonstration/__init__.py

@@ -0,0 +1,9 @@
+from django.apps import AppConfig
+
+
+class DemonstrationConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "demonstration"
+
+
+default_app_config = "demonstration.DemonstrationConfig"

source/forms/demonstration/forms/__init__.py

@@ -0,0 +1,3 @@
+from .person import PersonForm
+from .search import SearchForm
+from .upload import UploadForm

source/forms/demonstration/forms/person.py

@@ -0,0 +1,13 @@
+from datetime import date
+
+from django import forms
+
+
+class PersonForm(forms.Form):
+    """Example of form for person information."""
+
+    first_name = forms.CharField(max_length=32, label="first name")
+    last_name = forms.CharField(max_length=32, label="last name")
+    birth_date = forms.DateField(initial=date(1990, 1, 1), label="birthday")
+    phone_number = forms.CharField(max_length=12, label="phone number")
+    password = forms.CharField(widget=forms.PasswordInput, max_length=50, label="password")

source/forms/demonstration/forms/search.py

@@ -0,0 +1,24 @@
+from typing import List
+
+from django import forms
+from django.core.exceptions import ValidationError
+
+
+class SearchForm(forms.Form):
+    """Example of search form."""
+
+    FORBIDDEN_WORDS: List[str] = ["lemon", "hat", "car"]
+    query = forms.CharField(max_length=32, label="query", required=True)
+
+    def clean_query(self) -> str:
+        """
+        Validate the query field.
+
+        Returns:
+            The value for the "cleaned" query field.
+
+        """
+        value: str = self.cleaned_data["query"]
+        if value.lower() in self.FORBIDDEN_WORDS:
+            raise ValidationError(f"Search term cannot be one of the following: {self.FORBIDDEN_WORDS}")
+        return value

source/forms/demonstration/forms/upload.py

@@ -0,0 +1,26 @@
+from django import forms
+from django.core.files.storage import FileSystemStorage
+from django.http import HttpRequest
+
+
+class UploadForm(forms.Form):
+    """Example of file upload form."""
+
+    image = forms.ImageField(max_length=128, required=True, label="image")
+
+    @staticmethod
+    def save_uploaded_file(request: HttpRequest) -> str:
+        """
+        Custom method to process the upload of the image.
+
+        Args:
+            request: HTTP request.
+
+        Returns:
+            URL of the new uploaded image.
+
+        """
+        storage = FileSystemStorage()
+        image = request.FILES["image"]
+        name = storage.save(None, image)
+        return storage.url(name)

source/forms/demonstration/static/demonstration/demonstration.css

@@ -0,0 +1,77 @@
+:root {
+    --head-bg-color: #222;
+    --head-fg-color: #fff;
+    --head-ln-color: #3cf;
+}
+
+html, body {
+    height: 100%;
+    min-height: 100%;
+    width: 100%;
+}
+
+body {
+    margin: 0;
+    display: grid;
+    grid-template-areas: "header" "content" "footer";
+    grid-template-rows: auto 1fr auto;
+    grid-template-columns: 100%;
+    font-family: "Roboto", "Lucida Grande", "DejaVu Sans", "Bitstream Vera Sans", Verdana, Arial, sans-serif;
+}
+
+section#header {
+    grid-area: header;
+}
+
+section#content {
+    grid-area: content;
+}
+
+section#footer {
+    grid-area: footer;
+}
+
+
+section#header, section#footer {
+    background-color: var(--head-bg-color);
+    color: var(--head-fg-color);
+}
+
+section#header a, section#footer a {
+    color: var(--head-ln-color);
+    text-decoration: none;
+}
+
+div.body {
+    width: 1024px;
+    margin: 1.5em auto;
+}
+
+table.form-table {
+    width: 100%;
+}
+
+table.form-table th {
+    text-align: left;
+}
+
+table.form-table td {
+    text-align: right;
+}
+
+table.form-table td > input[type=text] {
+    width: 100%;
+    box-sizing: border-box;
+
+}
+
+input[type=submit] {
+    padding: 0.5em 4em;
+    margin: 0;
+    background-color: crimson;
+    color: white;
+    font-size: 125%;
+    border: maroon 1px solid;
+    border-radius: 0.5em;
+    box-shadow: coral 0 0 0 1px inset;
+}

source/forms/demonstration/templates/demonstration/base.html

@@ -0,0 +1,33 @@
+{% load static %} {# The load tag enables template tags from other Django apps #}
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>{% block title %} | Django Demonstration{% endblock title %}</title>
+    <link rel="stylesheet" href="{% static "demonstration/demonstration.css" %}">
+</head>
+<body>
+<section id="header">
+    <div class="body">
+        <nav>
+            <a href="/">Home page</a>
+        </nav>
+    </div>
+</section>
+<section id="content">
+    <div class="body">
+        {% block body %}
+            Base content in a overridable block.
+        {% endblock body %}
+    </div>
+</section>
+<section id="footer">
+    <div class="body">
+        {% block footer %}
+            ©2021 Steve Kossouho, <strong>Dawan</strong>
+        {% endblock footer %}
+    </div>
+</section>
+
+</body>
+</html>

source/forms/demonstration/templates/demonstration/index.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Forms demonstration</title>
+</head>
+<body>
+<h1>Sections of form rendering</h1>
+<ul>
+    <li><a href="{% url "search" %}">Search form</a></li>
+    <li><a href="{% url "person" %}">Person fields form</a></li>
+    <li><a href="{% url "upload" %}">Upload form</a></li>
+</ul>
+</body>
+</html>

source/forms/demonstration/templates/demonstration/person_form_view.html

@@ -0,0 +1,15 @@
+{% extends "demonstration/base.html" %}
+
+{% block body %}
+    <form action="" method="post" name="person-form">
+        {% csrf_token %}
+        <table class="form-table">
+            {{ form.as_table }}
+            <tr>
+                <th></th>
+                <td><input type="submit" name="submit-form" value="Validate"></td>
+            </tr>
+        </table>
+    </form>
+    <hr>
+{% endblock body %}

source/forms/demonstration/templates/demonstration/search_form_view.html

@@ -0,0 +1,22 @@
+{% extends "demonstration/base.html" %}
+
+{% block body %}
+    <form action="" method="get" name="search-form">
+        <table class="form-table">
+            {{ form.as_table }}
+            <tr>
+                <th></th>
+                <td><input type="submit" name="submit-form" value="Search"></td>
+            </tr>
+        </table>
+    </form>
+    <hr>
+    <em>{{ results|length }} results.</em>
+    <ul>
+        {% for item in results %}
+            <li>{{ item }}</li>
+        {% empty %}
+            <li>No item found.</li>
+        {% endfor %}
+    </ul>
+{% endblock body %}

source/forms/demonstration/templates/demonstration/upload_form_view.html

@@ -0,0 +1,21 @@
+{% extends "demonstration/base.html" %}
+
+{% block body %}
+    <form action="" method="post" name="upload-form" enctype="multipart/form-data">
+        {% csrf_token %}
+        <table class="form-table">
+            {{ form.as_table }}
+            <tr>
+                <th></th>
+                <td><input type="submit" name="submit-form" value="Upload file"></td>
+            </tr>
+        </table>
+    </form>
+    <hr>
+    {% if image_url %}
+        The image was successfully uploaded at <a href="{{ image_url }}">{{ image_url }}</a>
+        <p>
+            <img src="{{ image_url }}" alt="Uploaded image">
+        </p>
+    {% endif %}
+{% endblock body %}

source/forms/demonstration/urls.py

@@ -0,0 +1,9 @@
+from django.urls import path
+
+from demonstration.views import view_search_form, view_person_form, view_upload_form
+
+urlpatterns = [
+    path("search/", view_search_form, name="search"),
+    path("person/", view_person_form, name="person"),
+    path("upload/", view_upload_form, name="upload"),
+]

source/forms/demonstration/views.py

@@ -0,0 +1,81 @@
+from typing import List, Optional
+
+from annoying.decorators import render_to
+from django.http import HttpRequest, HttpResponseRedirect
+
+from demonstration.forms import SearchForm, PersonForm, UploadForm
+
+NAMES: List[str] = [
+    "Jean",
+    "Paul",
+    "Robert",
+    "Julien",
+    "Nicolas",
+    "François",
+    "Julie",
+    "Marie",
+    "Anne",
+    "Évelyne",
+    "Jeanne",
+    "Claire",
+]
+
+
+@render_to("demonstration/index.html")
+def view_index(request: HttpRequest):  # noqa
+    return {}
+
+
+@render_to("demonstration/search_form_view.html")
+def view_search_form(request: HttpRequest):  # noqa
+    """
+    View for the search form.
+
+    Args:
+        request: HTTP request.
+
+    Returns:
+        Data for rendering the template, as a context dictionary.
+
+    """
+    form = SearchForm(request.GET) if request.GET else SearchForm()
+    results: List[str] = []
+    if form.is_valid():
+        query: str = form.cleaned_data["query"].lower()
+        results = [item for item in NAMES if query in item.lower()]
+    return {"form": form, "results": results}
+
+
+@render_to("demonstration/person_form_view.html")
+def view_person_form(request: HttpRequest):  # noqa
+    """
+    View for the person form.
+
+    Args:
+        request: HTTP request.
+
+    Returns:
+        Data for rendering the template, as a context dictionary.
+
+    """
+    form = PersonForm(request.POST) if request.method == "POST" else PersonForm()
+    return {"form": form}
+
+
+@render_to("demonstration/upload_form_view.html")
+def view_upload_form(request: HttpRequest):  # noqa
+    """
+    View for the upload form.
+
+    Args:
+        request: HTTP request.
+
+    Returns:
+        Data for rendering the template, as a context dictionary.
+
+    """
+    form = UploadForm(request.POST, request.FILES) if request.method == "POST" else UploadForm()
+    image_url: Optional[str] = None
+    if form.is_valid():
+        image_url = form.save_uploaded_file(request)
+    return {"form": form, "image_url": image_url}

source/forms/forms/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for forms 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.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'forms.settings')
+
+application = get_asgi_application()

source/forms/forms/settings.py

@@ -0,0 +1,131 @@
+"""
+Django settings for forms project.
+
+Generated by 'django-admin startproject' using Django 3.2.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/3.2/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/3.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-fp_2(q#373yxtz=sn7!58+x##q_qan$ef#itrz10qj5=e1@w_0"
+
+# 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",
+    "demonstration",
+]
+
+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 = "forms.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 = "forms.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/3.2/ref/settings/#databases
+
+DATABASES = {
+    # "default": {
+    #     "ENGINE": "django.db.backends.sqlite3",
+    #     "NAME": BASE_DIR / "db.sqlite3",
+    # }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/3.2/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/3.2/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.2/howto/static-files/
+
+STATIC_URL = "/static/"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+# Media paths
+
+MEDIA_URL = "/media/"
+MEDIA_ROOT = BASE_DIR / "media"

source/forms/forms/urls.py

@@ -0,0 +1,25 @@
+"""forms URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/3.2/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.conf import settings
+from django.conf.urls.static import static
+from django.urls import path, include
+
+from demonstration.views import view_index
+
+urlpatterns = [
+    path("demonstration/", include("demonstration.urls")),
+    path("", view_index, name="index"),
+] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

source/forms/forms/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for forms 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.2/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'forms.settings')
+
+application = get_wsgi_application()

source/forms/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', 'forms.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()