Skip to main content

Django plugin to add and configure the Cookie Control by Civic UK

Project description

django-cookie-control

A Django plugin to integrate the Civic UK Cookie Control (https://www.civicuk.com/cookie-control)

The plugin is compatible with Django, DjangoCMS and Django/CMS multisite.

To install

Install the application via pip:

pip install django-cookie-control

Add 'django_cookie_control' to installed apps:

INSTALLED_APPS = [ ... 'django_cookie_control', ...]

Add/Edit the following to settings.py if required with required cookies:

# DEFAULT if missing:
COOKIE_CONTROL_REQUIRED_COOKIES = ['csrftoken','django_language','sessionid','django_privacy_mgmt_preferences','AWSALB']

Run or make migrations:

python.exe manage.py migrate

To configure

For a full list of configuration settings see the Civic UK site, here:

https://www.civicuk.com/cookie-control/v8/documentation

Plugin configuration overview:

  1. Add a new configuration - custom configuration for different sites via multisite.

  1. Configure Main Settings
  • Site name
  • API key
  • Cookie Control product version: Community, Pro, Pro Multisite

  1. Display Options
  • Position
  • Theme style
  • Toggle type
  • Close style

  1. Text and Accessibility

  1. Custom Settings

  1. Pro and Pro_Multisite Settings A series of settings for the paid Pro plugins, including:
  • Custom text
  • Custom formatting

  1. Cookies
  • Necessary Cookies
    • A simple list of cookie names, including wildcards that are necessary for the site
    • A default list for Django, DjangoCMS, and AWS are already included.
  • Optional Cookies
    • Add an optional cookie or package of cookies that can be turned off for the site
    • Using separate functions On Accept or for On Revoke the cookies can be customised to be disable or enabled.

To Test

Use IE11's emulation to test this tool -

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_cookie_control-1.1.0.tar.gz (25.3 kB view hashes)

Uploaded Source

Built Distribution

django_cookie_control-1.1.0-py3-none-any.whl (28.9 kB view hashes)

Uploaded Python 3

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