Flake8 and black

.flake8

@@ -0,0 +1,5 @@
+[flake8]
+ignore = D203
+max-complexity = 10
+max-line-length = 120
+exclude = .venv

README.md

@@ -15,7 +15,7 @@ https://django-example-quizsite.azurewebsites.net/quizzes/
 Install the requirements:
 
 ```
-pip install -r requirements.txt
+pip install -r requirements-dev.txt
 ```
 
 Create a local PostGreSQL database called "quizsite"

manage.py

@@ -11,13 +11,13 @@ def main():
     # If WEBSITE_HOSTNAME is defined as an environment variable, then we're running on Azure App Service
 
     # Only for Local Development - Load environment variables from the .env file
-    if not 'WEBSITE_HOSTNAME' in os.environ:
+    if "WEBSITE_HOSTNAME" not in os.environ:
         print("Loading environment variables for .env file")
-        load_dotenv('./.env')
+        load_dotenv("./.env")
 
     # When running on Azure App Service you should use the production settings.
-    settings_module = "quizsite.production" if 'WEBSITE_HOSTNAME' in os.environ else 'quizsite.settings'
-    os.environ.setdefault('DJANGO_SETTINGS_MODULE', settings_module)
+    settings_module = "quizsite.production" if "WEBSITE_HOSTNAME" in os.environ else "quizsite.settings"
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", settings_module)
 
     try:
         from django.core.management import execute_from_command_line
@@ -30,5 +30,5 @@ def main():
     execute_from_command_line(sys.argv)
 
 
-if __name__ == '__main__':
-    main()
+if __name__ == "__main__":
+    main()

pyproject.toml

@@ -0,0 +1,10 @@
+[tool.black]
+line-length = 120
+target-version = ['py39']
+exclude = '''
+/(
+  | \.venv
+  | migrations
+)/
+
+'''

quizsite/production.py

@@ -1,23 +1,23 @@
-from .settings import *
+from .settings import * # noqa
 import os
 
 # Configure the domain name using the environment variable
 # that Azure automatically creates for us.
-ALLOWED_HOSTS = [os.environ['WEBSITE_HOSTNAME']] if 'WEBSITE_HOSTNAME' in os.environ else []
-CSRF_TRUSTED_ORIGINS = ['https://'+ os.environ['WEBSITE_HOSTNAME']] if 'WEBSITE_HOSTNAME' in os.environ else []
+ALLOWED_HOSTS = [os.environ["WEBSITE_HOSTNAME"]] if "WEBSITE_HOSTNAME" in os.environ else []
+CSRF_TRUSTED_ORIGINS = ["https://" + os.environ["WEBSITE_HOSTNAME"]] if "WEBSITE_HOSTNAME" in os.environ else []
 DEBUG = False
 
 # DBHOST is only the server name, not the full URL
-hostname = os.environ['DBHOST']
+hostname = os.environ["DBHOST"]
 
 # Configure Postgres database; the full username for PostgreSQL flexible server is
 # username (not @sever-name).
 DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.postgresql',
-        'NAME': os.environ['DBNAME'],
-        'HOST': hostname + ".postgres.database.azure.com",
-        'USER': os.environ['DBUSER'],
-        'PASSWORD': os.environ['DBPASS']
+    "default": {
+        "ENGINE": "django.db.backends.postgresql",
+        "NAME": os.environ["DBNAME"],
+        "HOST": hostname + ".postgres.database.azure.com",
+        "USER": os.environ["DBUSER"],
+        "PASSWORD": os.environ["DBPASS"],
     }
-}
+}

quizsite/settings.py

@@ -33,7 +33,7 @@ ALLOWED_HOSTS = []
 # Application definition
 
 INSTALLED_APPS = [
-    'quizzes.apps.QuizzesConfig',
+    "quizzes.apps.QuizzesConfig",
     "django.contrib.admin",
     "django.contrib.auth",
     "django.contrib.contenttypes",
@@ -79,10 +79,10 @@ WSGI_APPLICATION = "quizsite.wsgi.application"
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.postgresql_psycopg2",
-        'NAME': os.environ['DBNAME'],
-        'HOST': os.environ['DBHOST'],
-        'USER': os.environ['DBUSER'],
-        'PASSWORD': os.environ['DBPASS']
+        "NAME": os.environ["DBNAME"],
+        "HOST": os.environ["DBHOST"],
+        "USER": os.environ["DBUSER"],
+        "PASSWORD": os.environ["DBPASS"],
     }
 }
 

quizsite/urls.py

@@ -17,6 +17,6 @@ from django.contrib import admin
 from django.urls import include, path
 
 urlpatterns = [
-    path('quizzes/', include('quizzes.urls')),
-    path('admin/', admin.site.urls),
-]
+    path("quizzes/", include("quizzes.urls")),
+    path("admin/", admin.site.urls),
+]

quizsite/wsgi.py

@@ -11,7 +11,7 @@ import os
 
 from django.core.wsgi import get_wsgi_application
 
-settings_module = 'quizsite.production' if 'WEBSITE_HOSTNAME' in os.environ else 'quizsite.settings'
+settings_module = "quizsite.production" if "WEBSITE_HOSTNAME" in os.environ else "quizsite.settings"
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", settings_module)
 
 application = get_wsgi_application()

quizzes/admin.py

@@ -1,15 +1,19 @@
 from django.contrib import admin
-from .models import Quiz, Question, Answer, FreeTextAnswer, MultipleChoiceAnswer
+from .models import Quiz, Question, FreeTextAnswer, MultipleChoiceAnswer
 
 admin.site.register(Quiz)
 
+
 class FreeTextAnswerInline(admin.StackedInline):
     model = FreeTextAnswer
 
+
 class MultipleChoiceAnswerInline(admin.StackedInline):
     model = MultipleChoiceAnswer
 
+
 class QuestionAdmin(admin.ModelAdmin):
     inlines = [FreeTextAnswerInline, MultipleChoiceAnswerInline]
 
-admin.site.register(Question, QuestionAdmin)
+
+admin.site.register(Question, QuestionAdmin)

quizzes/models.py

@@ -3,62 +3,60 @@ from django.contrib.postgres import fields
 
 
 class Quiz(models.Model):
-  name = models.CharField(max_length=100)
-
-  def __str__(self):
-    return f"<Quiz: {self.name}>"
-
-  def display(self):
-    # Display the quiz name
-    print(f"Welcome to the quiz on {self.name}!")
-    # Initialize the correct counter to 0
-    correct_count = 0
-    # Iterate through the questions
-    #  Display each question
-    #  Increment the correct counter accordingly
-    for question in self.questions:
-      question.display()
-      if question.answer_status == 'correct':
-        correct_count += 1
-    # Print the ratio of correct/total
-    print(f"You got {correct_count}/{len(self.questions)} correct.")
-
+    name = models.CharField(max_length=100)
+
+    def __str__(self):
+        return f"<Quiz: {self.name}>"
+
+    def display(self):
+        # Display the quiz name
+        print(f"Welcome to the quiz on {self.name}!")
+        # Initialize the correct counter to 0
+        correct_count = 0
+        # Iterate through the questions
+        #  Display each question
+        #  Increment the correct counter accordingly
+        for question in self.questions:
+            question.display()
+            if question.answer_status == "correct":
+                correct_count += 1
+        # Print the ratio of correct/total
+        print(f"You got {correct_count}/{len(self.questions)} correct.")
 
 
 class Question(models.Model):
-  quiz = models.ForeignKey(Quiz, on_delete=models.CASCADE)
-  prompt = models.CharField(max_length=200)
+    quiz = models.ForeignKey(Quiz, on_delete=models.CASCADE)
+    prompt = models.CharField(max_length=200)
+
+    def __str__(self):
+        return self.prompt
 
-  def __str__(self):
-    return self.prompt
 
 class Answer(models.Model):
-  question = models.OneToOneField(
-        Question,
-        on_delete=models.CASCADE
-    )
-  correct_answer = models.CharField(max_length=200)
+    question = models.OneToOneField(Question, on_delete=models.CASCADE)
+    correct_answer = models.CharField(max_length=200)
 
+    class Meta:
+        abstract = True
 
-  class Meta:
-    abstract = True
 
 class FreeTextAnswer(Answer):
-  case_sensitive = models.BooleanField(default=False)
+    case_sensitive = models.BooleanField(default=False)
+
+    def __str__(self):
+        return self.correct_answer
 
-  def __str__(self):
-    return self.correct_answer
+    def is_correct(self, user_answer):
+        if not self.case_sensitive:
+            return user_answer.lower() == self.correct_answer.lower()
+        return user_answer == self.correct_answer
 
-  def is_correct(self, user_answer):
-    if not self.case_sensitive:
-      return user_answer.lower() == self.correct_answer.lower()
-    return user_answer == self.correct_answer
 
 class MultipleChoiceAnswer(Answer):
-  choices = fields.ArrayField(models.CharField(max_length=200, blank=True))
+    choices = fields.ArrayField(models.CharField(max_length=200, blank=True))
 
-  def __str__(self):
-    return f"{self.correct_answer} from {self.choices}"
+    def __str__(self):
+        return f"{self.correct_answer} from {self.choices}"
 
-  def is_correct(self, user_answer):
-    return user_answer == self.correct_answer
+    def is_correct(self, user_answer):
+        return user_answer == self.correct_answer

quizzes/tests.py

@@ -1,3 +1,3 @@
-from django.test import TestCase
+# from django.test import TestCase
 
 # Create your tests here.

quizzes/urls.py

@@ -2,11 +2,11 @@ from django.urls import path
 
 from . import views
 
-app_name = 'quizzes'
+app_name = "quizzes"
 
 urlpatterns = [
-    path('', views.index, name='index'),
-    path('<int:quiz_id>/', views.display_quiz, name='display_quiz'),
-    path('<int:quiz_id>/questions/<int:question_id>', views.display_question, name='display_question'),
-    path('questions/<int:question_id>/grade/', views.grade_question, name='grade_question'),
-]
+    path("", views.index, name="index"),
+    path("<int:quiz_id>/", views.display_quiz, name="display_quiz"),
+    path("<int:quiz_id>/questions/<int:question_id>", views.display_question, name="display_question"),
+    path("questions/<int:question_id>/grade/", views.grade_question, name="grade_question"),
+]

quizzes/views.py

@@ -1,17 +1,20 @@
-from django.shortcuts import get_object_or_404,render, redirect
+from django.shortcuts import get_object_or_404, render, redirect
 from django.urls import reverse
 
 from .models import Quiz, Question
 
+
 def index(request):
     quiz_list = Quiz.objects.all()
-    context = {'quiz_list': quiz_list}
-    return render(request, 'quizzes/index.html', context)
+    context = {"quiz_list": quiz_list}
+    return render(request, "quizzes/index.html", context)
+
 
 def display_quiz(request, quiz_id):
     quiz = get_object_or_404(Quiz, pk=quiz_id)
     question = quiz.question_set.first()
-    return redirect(reverse('quizzes:display_question', kwargs={'quiz_id': quiz_id, 'question_id': question.pk}))
+    return redirect(reverse("quizzes:display_question", kwargs={"quiz_id": quiz_id, "question_id": question.pk}))
+
 
 def display_question(request, quiz_id, question_id):
     quiz = get_object_or_404(Quiz, pk=quiz_id)
@@ -23,10 +26,19 @@ def display_question(request, quiz_id, question_id):
             current_question = question
             if ind != len(questions) - 1:
                 next_question = questions[ind + 1]
-    return render(request, 'quizzes/display.html', {'quiz': quiz, 'question': current_question, 'next_question': next_question})
+    return render(
+        request,
+        "quizzes/display.html",
+        {"quiz": quiz, "question": current_question, "next_question": next_question},
+    )
+
 
 def grade_question(request, question_id):
     question = get_object_or_404(Question, pk=question_id)
-    answer = getattr(question, 'multiplechoiceanswer', None) or getattr(question, 'freetextanswer')
-    is_correct = answer.is_correct(request.POST.get('answer'))
-    return render(request, 'quizzes/partial.html', {'is_correct': is_correct, 'correct_answer': answer.correct_answer})
+    answer = getattr(question, "multiplechoiceanswer", None) or getattr(question, "freetextanswer")
+    is_correct = answer.is_correct(request.POST.get("answer"))
+    return render(
+        request,
+        "quizzes/partial.html",
+        {"is_correct": is_correct, "correct_answer": answer.correct_answer},
+    )

requirements-dev.txt

@@ -0,0 +1,4 @@
+-r requirements.txt
+black==22.3.0
+pre-commit
+flake8