Django Legal Advice Builder

Django Legal Advice Builder is a django app the can be used to create, edit and display multi-step questionaires and display the answers to those questionaires in an predefined document template. Basically it implements the three following functionalities:

1. UI to create questionaires with questions and branching
2. UI to create documents with textblocks that can include answers of the users and that can be displayed or not displayed based on the user's answer.
3. UI to display questioniares and documents (can also be downloaded as PDF)

How to get startet

For a quickstart just to see what the project is about you can pull and install the demo repository.

To add the legal-advice-app to your Django Project you need to:

1) install the app to your projects environment

pip install git+https://github.com/OpenLegalTech/django-legal-advice-builder.git

2) Add the app and some other required apps to your django settings file

INSTALLED_APPS = [
    ...
    'treebeard',
    'legal_advice_builder.apps.LegalAdviceBuilderConfig',
    'tinymce'
    ...
]

3) Add the legal-advice-builder urls to your urls.py

urlpatterns = [
    ...
    path('advice-builder', include('legal_advice_builder.urls')),
    ...
]

Per default only users who have access to the django admin (have the flag is_staff) are allowed to access those urls. If you want to change this, please checkout 5).

4) To add Questionaire urls

* add a view that inherits from FormWizardView and 
* overwrites `get_lawcase()`
* overwrite `legal_advice_builder/form_wizard.html`

e.g. like this:

from legal_advice_builder.models import LawCase
from legal_advice_builder.views import FormWizardView
...
class LawCaseForm(FormWizardView):

    def get_lawcase(self):
        pk = self.kwargs.get('pk')
        return LawCase.objects.get(pk=pk)  

5) Customize Access to Legal Advice Builder Adminarea

If you don't do anything only users who have access to the django admin (have the flag is_staff) have access to the urls that you added in step 3.

To change this, add a mixin that inherits from django.contrib.auth.mixins.UserPassesTestMixin and overwrite test_func with your custom permission code.

Then add the full import path to your django settings as LEGAL_ADVICE_BUILDER_PERMISSION_MIXIN

For example, if you wanted to have every user have access to the admin you could create a new Mixin

from django.contrib.auth.mixins import UserPassesTestMixin

class AllowAccessToAdminToEveryonaMixin(UserPassesTestMixin):
    def test_func(self):
        return True

then add the following line to your django settings.

LEGAL_ADVICE_BUILDER_PERMISSION_MIXIN = '<your-import-path-to-mixin>.AllowAccessToAdminToEveryonaMixin'

Check the Demo Project for reference.