Skip to main content

django-legaltext helps to manage legal text versioning.

Project description

Latest PyPI version Latest Travis CI build status

Legaltext is a Django application to help managing legal text versioning (e.g. terms of condition, pr privacy policy). It also supports versioning of the corresponding checkbox labels.

Features

The application consists of multiple parts and helpers:

  • Models to maintain legal texts, their versions and checkboxes

  • Model field to store the accepted version of a legal text (with support to auto-fetched default of current version)

  • Form field to render the widget which outputs the configured checkboxes just using the legal text slug

  • Admin interface to maintain the legal texts, adding new version with prefilling, and export

  • Templatetag legaltext_url

Installation

requirements.txt

Just add the following PyPI package to your requirements.txt

django-legaltext

settings.py

To activate the application, add the following two packages to your INSTALLED_APPS

INSTALLED_APPS = (
    ...
    'floppyforms',  # needed for widget rendering
    'markymark',  # required for markdown rendering
    'legaltext',
)

urls.py

To register the url to output the legal texts, add the following to your urls.py.

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

Usage

Please refer to the examples to learn how to use the application.

You just need to add a new model field to your models and set the correct formfield in the corresponding forms.

class YourModel(models.Model):
    ...

    accepted_legaltext = LegalTextField('some-unique-slug')
class YourForm(forms.ModelForm):

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.fields['accepted_legaltext'] = LegalTextFormField('some-unique-slug')

Make sure that you use the same slug on both (model and form) field.

Customization

There are some more settings you can set to change the applcation

  • LEGALTEXT_ANCHOR_CLASS Add an additional css class the the rendered anchor-span when using [anchor:foo]

  • LEGALTEXT_VIEW_TEMPLATE Change the template which is used to in the view to output the legal text

  • LEGALTEXT_VIEW_TEMPLATE_OVERRIDES Choose a different template to use in views for specific slugs

  • LEGALTEXT_WIDGET_TEMPLATE Change the template which is used to in the widget to output the checkboxes

  • LEGALTEXT_WIDGET_TEMPLATE_OVERRIDES Choose a different template to use in widget for specific slugs

  • LEGALTEXT_WIDGET_ATTRS Add extra attributes to checkbox input elements

  • LEGALTEXT_SILENCE_TEMPLATE_ERRORS Silence errors for legaltext_url templatetag if legaltext does not exist

Resources

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-legaltext-1.0.0.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

django_legaltext-1.0.0-py2.py3-none-any.whl (19.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-legaltext-1.0.0.tar.gz.

File metadata

  • Download URL: django-legaltext-1.0.0.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.6

File hashes

Hashes for django-legaltext-1.0.0.tar.gz
Algorithm Hash digest
SHA256 ff03499fa0a08eebad3bce35c5050ce153a174edcf2fb1700696cb6c36fc55d9
MD5 2ef779d84c45ab6078971d053e36f873
BLAKE2b-256 9d915decca27f48799b0ff609309ec11d1af1458b3646d423865a16964078b15

See more details on using hashes here.

File details

Details for the file django_legaltext-1.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_legaltext-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 428b14194b48c6114b05cde7972ef1cae785580040202f1b2e5a471ce560b0a8
MD5 dd369513b171a543562dd143181e0730
BLAKE2b-256 c3ad351c0af3b758e5ba75e5e05c5dfae83bded54a397670e180672d1e4a0354

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page