django-prompt-responses 0.1.1

Documentation

The full documentation is at https://django-prompt-responses.readthedocs.io.

Quickstart

Install prompt_responses:

pip install django-prompt-responses

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    ...
    'prompt_responses',
    'sortedm2m',  # for the ability to change the order of Prompts in the Django admin
    ...
)

Create Prompts, e.g. through the integrated admin views.

Deliver a prompt to the user:

prompt = Prompt.objects.get(id=1)
instance = prompt.get_instance()

"""
Use these variables to display the UI:
prompt.type
str(instance)
instance.object
instance.response_objects
"""

Save a user response:

prompt = Prompt.objects.get(id=1)
prompt.create_response(
    user=user,
    prompt_object=instance.object,
    rating=5
)

Analyze data:

prompt = Prompt.objects.get(id=1)
# Mean rating for all responses
rating = prompt.get_mean_rating()
# Mean ratings for all objects
matrix = prompt.get_mean_tag_rating_matrix()
# Mean ratings for one object
ratings = list(prompt.get_mean_tag_ratings(instance.object))

Use the included viewsets in your Django Rest Framework API:

from rest_framework import routers
from prompt_responses.viewsets import PromptViewSet

router = routers.DefaultRouter()
router.register(r'prompts', PromptViewSet)

urlpatterns = [
    url(r'^api/', include(router.urls))
]

This offers api/prompts/, api/prompts/<id>/, api/prompts/<id>/instantiate/, api/prompts/<id>/create-response/ (POST) endpoints.

Features

• Prompt types

  • Likert scale ratings

  • Open-ended free text

  • Tagging

• Populate prompts with objects in order to

  • let users rate objects from one set

  • let users rate (tag) relations between two sets of objects

• Analytics convenience functions

• (Coming soon) Plugable object sampling algorithms

• Support for Django Rest Framework

Running Tests

Credits

Tools used in rendering this package:

• Cookiecutter

• cookiecutter-djangopackage

History

0.1.0 (2017-11-07)

• First release on PyPI.