django-easy-quiz 4.2.2

Create weighted answers or interpretation quizzes with ease!

Create quizzes with ease!

Features

• Create weighted-answers quizzes (6 questions max, conclusions are in categories by points count, like "you have between 0 and 5 points", single (radio) OR multiple (checkboxes) answers per question!),
• Create interpretation quizzes (4 questions max, conclusions are in categories by max symbols count, like "you have a majority of ◆"),
• Create django-cms plugins that redirect to your quizzes (quizzes are available through a special url, you cannot add cms plugin to the quizzes by default).
• (optional) Save quizzes data in your database (started quizzes, finished quizzes, results)
• (optional) Add general questions to the end of the quiz to gather more data! ((fr) departements, job, age range, [...])
• (optional) Generate pdf from the saved data.

Warning!

Do not use versions < 3.0.0, they are not production-ready and have a lot of problems.

Install

1. Install the package:

   python3 -m pip install django-easy-quiz
   

2. Add those apps to your INSTALLED_APPS:

   "filer",
   "ckeditor",
   "ckeditor_uploader",  # for hosting images in your ckeditor view, see below for a ready-to-use config
   "ckeditor_filebrowser_filer",
   "django_easy_quiz",
   

3. Add the sessions middleware in your settings if it's not already here:

   MIDDLEWARE = (
       # [...]
       "django.contrib.sessions.middleware.SessionMiddleware",
       # [...]
   )
   

4. Add those urls in your urls.py:

   # main app urls
   path("quiz/", include("django_easy_quiz.urls")),
   # ckeditor-related urls
   path("ckeditor/", include("ckeditor_uploader.urls")),
   path("filer/", include("filer.urls")),
   path("filebrowser_filer/", include("ckeditor_filebrowser_filer.urls")),
   path("filebrowser_filer/filer_", include("ckeditor_filebrowser_filer.urls")),  # only add this line if you're using django-ckeditor-filebrowser-filer from the develop branch or our fork on the "various-fixes" branch
   

5. Migrate

   python3 manage.py migrate
   

6. That's all folks!

Config

Ckeditor config

You will need to configure django-ckeditor in order to make it work in the quiz descriptions. Here's a ready-to-use config snippet that you can paste on your project's settings:

CKEDITOR_UPLOAD_PATH = "uploads/"
CKEDITOR_IMAGE_BACKEND = "pillow"
CKEDITOR_THUMBNAIL_SIZE = (150, 150)
CKEDITOR_ALLOW_NONIMAGE_FILES = False
CKEDITOR_CONFIGS = {
  "default": {
    "language": "{{ language }}",
    "toolbar": "Simple",
    "toolbar_Simple": [
        ["Undo", "Redo"],
        ["Styles", "Format"],
        ["TextColor", "BGColor"],
        ["Subscript", "Superscript", "-", "RemoveFormat", "PasteText", "PasteFromWord", "FilerImage"],
        ["Link", "Unlink"],
        ["Source"],
    ],
    "autoParagraph": False,
    "colorButton_colors": "01b6ad,00b6ef,a0cd49,ffc01c,9d1a75,fff,000",
    "skin": "moono-lisa",
    "height": "600px",
    "extraPlugins": "filerimage",
    "removePlugins": "image"  # do not use the classic image plugin, use the one from django-ckeditor-filebrowser-filer
  }
}

You can learn more about thoses config values and customize them values by having a look at the django-ckeditor documentation.

Save quizzes in your database

Add DJANGO_EASY_QUIZ_SAVE_QUIZZES_RESULTS=True (default False) in your settings.

Display new questions at the end of the quiz

Add DJANGO_EASY_QUIZ_GATHER_STATISTICS_END=True (default False) in your settings.

Download pdf with infos on the quiz

Add DJANGO_EASY_QUIZ_SAVE_PDF (default False) in your settings.

Only work if DJANGO_EASY_QUIZ_SAVE_QUIZZES_RESULTS is true. Requires weasyprint. Template to edit is in django_easy_quiz/quiz_pdf.html.