## Documentation

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

## Quickstart

Install django-signoff:

pip install django-signoff

INSTALLED_APPS = (
...
'signoff.apps.SignoffConfig',
...
)

urlpatterns = [
...
url(r'^signoff/', include('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-signoff’s middleware:

MIDDLEWARE = (
...
'signoff.middleware.ConsentMiddleware',
...
)

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

# 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.
SIGNOFF_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.
SIGNOFF_EMAIL_RECEIPT = ['legal@example.com', ]

# We don't delete signatures from your database, for compliance reasons.
# However, we do require new signatures whenever a new version of a
# document is created by creating a new object and setting the
# prev_version field. You can also require new signatures whenever a
# document is edited in the admin (we check the updated field of
# the document, and only accept newer signatures):
SIGNOFF_CHECK_DOCUMENT_UPDATED = True

# You can also require new signatures whenever a user's display name
# changes (we require users to enter their display name when signing
# a document):
SIGNOFF_CHECK_FULL_NAME = True

# If you're using the middleware, it will redirect any logged-in requests
# from users who owe signatures to the 'legal' index by default, except
# for requests within the 'signoff' app (to avoid redirect loops), and
# requests to the 'auth_logout' url name (to allow users to log out
# of the site). If you want to add additional URLs that can be accessed
# by users who have not signed your documents yet, you can do something
# like the following:
# (The latter is only an example, 'auth_logout' is automatically allowed.)

• 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.1.1 (2018-06-04)

• The app is now usable as a very limited alpha * Email options advertised in readme are not implemented * Templates could use some work

### 0.1.0 (2018-06-03)

• Initial release, demonstration of models and core logic

## Project details

Uploaded source
Uploaded py2 py3