Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

Present users with your Terms of Service and other documents, and record their consent

Project description

https://badge.fury.io/py/django-signoff.svg https://travis-ci.org/dcollinsn/django-signoff.svg?branch=master https://codecov.io/gh/dcollinsn/django-signoff/branch/master/graph/badge.svg

Present users with your Terms of Service and other documents, and record their consent

Documentation

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

Quickstart

Install django-signoff:

pip install django-signoff

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'django_signoff.apps.DjangoSignoffConfig',
    ...
)

Add django-signoff’s URL patterns:

from django_signoff import urls as django_signoff_urls


urlpatterns = [
    ...
    url(r'^', include(django_signoff_urls)),
    ...
]

If you want users to be automatically prompted to sign any documents that you add before they can use your site, add django-consent’s middleware:

MIDDLEWARE = (
   ...
   'django-consent.middleware.ConsentMiddleware',
   ...
)

You can add some settings to your settings.py file to configure django-consent:

# Send a notification to the user by email (using django-mailer) when they
# sign a document, including the text of the document. Default is False.
CONSENT_EMAIL_USER = True

# Send a notification to a defined list of addresses whenever any user
# signs a document (may be useful for recordkeeping). Default is none.
CONSENT_EMAIL_RECEIPT = ['legal@example.com', ]

Features

  • TODO

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits

Tools used in rendering this package:

History

0.0.1 (2018-06-03)

  • Initial release, demonstration of models and core logic

Project details


Download files

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

Files for django-signoff, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size django_signoff-0.1.0-py2.py3-none-any.whl (8.7 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size django-signoff-0.1.0.tar.gz (8.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page