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 Maintainability License Tweet about this project https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg

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.7.tar.gz (64.6 kB view details)

Uploaded Source

Built Distribution

django_opt_out-0.1.7-py2.py3-none-any.whl (26.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for django-opt-out-0.1.7.tar.gz
Algorithm Hash digest
SHA256 9aa7d55f86e345a5a7f277d3640500e8683b6a80e9dfeba1a1d6cbfb68e4dd86
MD5 c09703139dd94867b0cb53b0a74c0abb
BLAKE2b-256 9a26d001508a70c485319be5a3cbde014d67894e397f9b4466d47e00ff88f91e

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for django_opt_out-0.1.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b030326e20fa51caec3880557ed338e513d2cc6641af606b616a3ca1f1a97c5d
MD5 6bb88e0e6de10b9bc19eb20f41558b88
BLAKE2b-256 44066e3cb91ca3afdcea37acdeda1c0076e0500665de64816edf2dbe0a9f22ab

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