Metadata-Version: 2.0
Name: django-signoff
Version: 0.1.0
Summary: Present users with your Terms of Service and other documents, and record their consent
Home-page: https://github.com/dcollinsn/django-signoff
Author: Dan Collins
Author-email: dan@dcollins.cc
License: MIT
Keywords: django-signoff
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django :: 2.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: django-model-utils (>=2.0)

=============================
django-signoff
=============================

.. image:: https://badge.fury.io/py/django-signoff.svg
    :target: https://badge.fury.io/py/django-signoff

.. image:: https://travis-ci.org/dcollinsn/django-signoff.svg?branch=master
    :target: https://travis-ci.org/dcollinsn/django-signoff

.. image:: https://codecov.io/gh/dcollinsn/django-signoff/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/dcollinsn/django-signoff

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

.. code-block:: python

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

Add django-signoff's URL patterns:

.. code-block:: python

    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:

.. code-block:: python

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

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

.. code-block:: python

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

*  Cookiecutter_
*  `cookiecutter-djangopackage`_

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




History
-------

0.0.1 (2018-06-03)
++++++++++++++++++

* Initial release, demonstration of models and core logic


