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

Uploaded Source

Built Distribution

django_opt_out-0.1.12-py2.py3-none-any.whl (29.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for django-opt-out-0.1.12.tar.gz
Algorithm Hash digest
SHA256 428db630c00f82730698fe795d45e74027bfd3aeed2efc9b61cb460296276939
MD5 cc110e7e91cd026b1d729db2925d0b30
BLAKE2b-256 1e918fc0874dccc9df33fe107c4c6ed5c6666d9883991b474ba7a6689fa0eba5

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for django_opt_out-0.1.12-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ee8f9f9777a76fd86f62dac39b152e7c20a785717aaa9683bbaca2290e2d203b
MD5 f80998c678125e31e590018423506ce9
BLAKE2b-256 4dd480c2e253e9eef4a73a19120ba481d731d0b85764a18cbc7065cf3e959b11

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