Skip to main content

Allow everybody to unsubscribe your messages, user accounts are not required.

Project description

https://img.shields.io/pypi/v/django-opt-out.svg https://img.shields.io/travis/wooyek/django-opt-out.svg Documentation Status Coveralls.io coverage CodeCov coverage License Tweet about this project

Allow everybody to unsubscribe your messages, user accounts are not required.

Features

  • A single page form for opt-out feedback submission

  • Feedback options text controlled from django admin

  • Predefined feedback defaults available from django manage command

  • Feedback translations done in django admin

  • Feedback options selection based on tags supplied to the opt-out url

  • Ability to preselect a feedback option

  • Ability to change selected feedback options after submission

  • Ability to set tag:value pair on opt-out url and store them on submission with user feedback

  • Signal to modify opt-out form before rendering

  • Signal on opt-out feedback submission

  • Easily overridable thank you / goodbye view

  • Opt-out form with a easily overridable base template

Demo

To run an example project for this django reusable app, click the button below and start a demo serwer on Heroku

Deploy Django Opt-out example project to Heroku

Quickstart

Install Django Opt-out application:

pip install django-opt-out

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'django_opt_out.apps.DjangoOptOutConfig',
    ...
)

Add Django Opt-out application’s URL patterns:

from django_opt_out import urls as django_opt_out_urls


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

Running Tests

Does the code actually work?

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

Credits

This package was created with Cookiecutter and the wooyek/cookiecutter-django-app project template.

History

0.1.0 (2017-11-03)

  • First release on PyPI.

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-opt-out-0.1.3.tar.gz (57.3 kB view details)

Uploaded Source

Built Distribution

django_opt_out-0.1.3-py2.py3-none-any.whl (22.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-opt-out-0.1.3.tar.gz.

File metadata

File hashes

Hashes for django-opt-out-0.1.3.tar.gz
Algorithm Hash digest
SHA256 709d5d269c26b8c11eca2c4f574b0ba855e3bc44d82e1e963d48542d13bf0ede
MD5 2ad59f32f978e1cb67d6ae2525d2915d
BLAKE2b-256 edde89a9d59e0b2645fa764b217afccc06d676152b89aea5cb331b72cc9797f7

See more details on using hashes here.

Provenance

File details

Details for the file django_opt_out-0.1.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_opt_out-0.1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8d462044ff26a00d8a16bdca1d6947449b1d9c432803b0bbf53d46a48cc2b664
MD5 173e402d66fb149351498e992a8fcae6
BLAKE2b-256 0537f72c1f62ad1715bf93f3c4f64c9d74ddff71ca3a6efa6b0b3e5cc2e76155

See more details on using hashes here.

Provenance

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