Logo by [@aurorachiarello](http://github.com/aurorachiarello)
[](https://travis-ci.org/bulkan/django-domande)
A plugable Django app to represent a generic questions on forms.
Dependencies
============
Here are the list of dependencies;
* [django-crispy-forms](http://django-crispy-forms.readthedocs.org) - This is used to render form fields with Bootstrap classes
* [django_polymorphic](https://github.com/chrisglass/django_polymorphic/) - Provides an easy way of doing model inheritence.
* [South](http://south.readthedocs.org/en/latest/) - For model migration. Please use it :smile:
Installation
===========
For stable PyPI version
pip install django-domande
To get development version
pip install git+git://github.com/bulkan/django-domande.git
In your ```settings.py``` file change ```INSTALLED_APPS``` and add;
```python
INSTALLED_APPS = [
...
'crispy-forms' # need to add this for it's template tags to load
'polymorphic', # provides admin templates
'domande'
...
]
```
__Note__ I'm assuming you have South already installed if not add ```south``` to ```INSTALLED_APPS```
General
-------
```domande``` uses model inheritence to simplify relationships to a list of questions and it does this with
the help of ```django-polymorphic```. At the moment ```domande``` supports two types of questions that are
rendered differently by their accompanying forms.
A TextQuestion were the __answer__ is a text and a ChoiceQuestion were the __answer__ is chosen
by a set of Choices. TextQuestion and ChoiceQuestion are subclasses of Question.
Example Usage
=============
Models
-----
Create a model with a ManyToManyField to domande.models.Question. For example a Questionnaire;
```python
from django.db import models
from django.contrib.contenttypes import generic
from domande.models import Question, Answer
class Questionnaire(models.Model):
name = models.CharField(max_length=256)
questions = models.ManyToManyField(Question)
```
Once you add a ManyToManyField to ```domande.models.Question``` and register your model with the django admin
interface the questions field will be handled uniquely. As ```domande.models.Questions``` is the parent model
when you create a new one the admin inteface will display an additional step of choosing the child model to create an
instance of.
View
----
Now you need to render the list of Questions in a view;
```python
def questionnaire_view(request):
# for sake of example use .get
questionnaire = Questionnaire.objects.get(id=1)
forms = [q.get_form()(prefix=str(q.id),
content_object=request.user,
question=q, form_tag=False)
for q in questionnaire.questions.all().get_real_instances()
]
# form is a list of TextQuestionForm or ChoiceQuestionForm
```
domande's forms accept a ```content_object``` that is used when it creates and saves an Answer.
domande doesn't know in advance what type of _user_ or _entry_ model you have so it uses
django's builtin ```ContentType``` framework to solve this.
In the above example it uses ```request.user```.
Template
--------
in the template render the forms like so;
```html
{% load crispy_forms_tags %}
<form method="post">
{% for form in forms %}
{% crispy form %}
{% endfor %}
</form>
```
to process the validity of the forms and save the Answers;
```python
def save_view(request, questionnaire):
# for sake of example use .get
questionnaire = Questionnaire.objects.get(id=questionnaire)
forms = [q.get_form()(request.POST or None,
prefix=str(q.id),
content_object=request.user,
question=q, form_tag=False)
for q in questionnaire.questions.all().get_real_instances()
]
forms_are_valid = []
for form in forms:
forms_are_valid.append(valid)
valid = form.is_valid()
if valid:
t = form.save()
forms_are_valid = all(forms_are_valid)
```
Each question model in domande has an Answer model that relates to it. A ChoiceQuestion will use a
ChoiceAnswer and a TextQuestion will use a ChoiceAnswer.
Development
===========
* Fork this repo, create a virtualenv and clone your fork. Then install the requirements
pip install -r requirements.txt
* If you have changed the models then create a migration;
django-admin.py schemamigration --settings=domande.settings --pythonpath=$PWD
* Please make sure existing tests pass and feel free to add more tests as you see fit.
django-admin.py test --settings='tests.test_settings' --pythonpath=$PWD
* Submit Pull Request
Metadata
Release files for django-domande 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| django-domande-0.1.4.tar.gz | 10.6 kB | Without provenance | Details for django-domande-0.1.4.tar.gz |
Release files / django-domande-0.1.4.tar.gz
| Download URL | django-domande-0.1.4.tar.gz |
|---|---|
| Size | 10.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9a103b207f58f3a50e4cbafc0eab49273c55cc2bc279eb66a9e30473a397f0b2
|
|
BLAKE2b-256 checksum How to use checksums |
1a1196220fe12707008dda2cf3f5299483aa4953b6b2eea1a856e3723577ba4e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for django-domande 0.1.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.