https://github.com/graup/django-prompt-responses

Reusable prompt and user responses data schema for Django
https://github.com/graup/django-prompt-responses

django

Last synced: 21 days ago
JSON representation

Reusable prompt and user responses data schema for Django

• Host: GitHub
• URL: https://github.com/graup/django-prompt-responses
• Owner: graup
• License: mit
• Created: 2017-11-07T05:45:36.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-26T20:36:09.000Z (about 2 years ago)
• Last Synced: 2024-11-20T02:37:52.045Z (about 2 months ago)
• Topics: django
• Language: Python
• Homepage:
• Size: 82 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=============================

prompt_responses

=============================

.. image:: https://badge.fury.io/py/django-prompt-responses.svg

    :target: https://badge.fury.io/py/django-prompt-responses

.. image:: https://travis-ci.org/graup/django-prompt-responses.svg?branch=master

    :target: https://travis-ci.org/graup/django-prompt-responses

.. image:: https://codecov.io/gh/graup/django-prompt-responses/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/graup/django-prompt-responses

A flexible prompt and user responses data schema utilizing Django's content types framework.

This app was born during a university research project. The main use case is data collection.

It lets you create numerous kinds of "prompts" (questions or tasks) and record user responses.

Prompts can be populated with any kind of database object.

This supports these kind of prompts:

* How do you feel today on a 1-5 scale? (Simple likert question)

* How do you like {object} on a 1-10 scale? (Object-based likert question)

* Which word do you associate with {object}? (Object-based open-ended question)

* How related do you think is {object} to these other objects? (Tagging task)

Ratings and tags are simply integer values, their meaning can be defined by your application

(e.g. 1 to 5 scales, or -1 = no, +1 = yes, and so on).

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`:

.. code-block:: python

    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:

.. code-block:: python

    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:

.. code-block:: python

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

    prompt.create_response(

        user=user,

        prompt_object=instance.object,

        rating=5

    )

Analyze data:

.. code-block:: python

    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:

.. code-block:: python

    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//`, `api/prompts//instantiate/`,

`api/prompts//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`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage