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 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)),
    ...
]

Add unsubscribe links to your emails:

from django_opt_out.utils import get_opt_out_path
email='Django Opt-out <django-opt-out@niepodam.pl>'
unsubscribe = get_opt_out_path(email, 'some', 'tags', 'controlling', 'questionnaire')

# unsubscribe link will not have a domain name and scheme
# you can build prefix from request, but I prefer to set it in settings
from django.conf import settings
unsubscribe = settings.BASE_URL + unsubscribe
body = 'Hello, Regards\n\nUnsubscribe: ' + unsubscribe

from django.core import mail
message = mail.EmailMultiAlternatives(body=body, to=[email])
message.extra_headers['List-Unsubscribe'] = "<{}>".format(unsubscribe)
message.send()

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

Uploaded Source

Built Distribution

django_opt_out-0.9.6-py2.py3-none-any.whl (33.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: django-opt-out-0.9.6.tar.gz
  • Upload date:
  • Size: 197.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.6

File hashes

Hashes for django-opt-out-0.9.6.tar.gz
Algorithm Hash digest
SHA256 e18cb74549f26f48edcdfce426dde5dd07d70e916295a61280fdb57726fc4e21
MD5 939bb1a9f5b7a23eb9ab801934571955
BLAKE2b-256 750ce106e2749e9fe6dd789e47d072f3540bf54e15582327bf1d47b5e1119fee

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_opt_out-0.9.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f58230c7c6ecc46e8137c730c92b03dd64ed7f35411e412f467e81d6f11911df
MD5 db0cd22f2fdf3f901205412c74f8f874
BLAKE2b-256 2b22e9fb0489a2c44ae0191a0845916eceb0de123c0dc99f7ddbeb4328849885

See more details on using hashes here.

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