Skip to main content

Helps your Django project comply with EU cookie law regulations

Project description

https://travis-ci.org/TyMaszWeb/django-cookie-law.svg?branch=master

django-cookie-law helps your Django project comply with the EU cookie regulations. by displaying a cookie information banner until it is dismissed by the user.

Warning

The app can be incompatible with your local cookie law regulations. Consult your lawyer when in doubt.

Contributions and comments are welcome using Github at: http://github.com/TyMaszWeb/django-cookie-law

Please note that django-cookie-law requires:

  • Django >= 1.8
  • django-classy-tags >= 0.3.0

Installation

  1. pip install django-cookie-law

  2. Add 'cookielaw' to INSTALLED_APPS

  3. Run collectstatic (Django 1.3+) or copy the statics to your media directory

  4. Add cookielaw/js/cookielaw.js to the markup directly or via your asset manager such as django-pipeline or django-compressor

  5. If you’re using Django > 1.8, enable 'django.core.context_processors.request' in your TEMPLATES['OPTIONS'] setting, eg.:

    TEMPLATES = [
        {
            'BACKEND': 'django.template.backends.django.DjangoTemplates',
            'DIRS': [],
            'APP_DIRS': True,
            'OPTIONS': {
                'context_processors': [
                    'django.template.context_processors.debug',
                    'django.core.context_processors.i18n',
                    'django.core.context_processors.media',
                    'django.template.context_processors.request',
                    'django.contrib.auth.context_processors.auth',
                    'django.core.context_processors.static',
                    'django.core.context_processors.tz',
                    'django.contrib.messages.context_processors.messages',
                ],
            },
        },
    ]
    

If you’re using an older version of Django (< 1.8) then you’ll want to change the TEMPLATE_CONTEXT_PROCESSORS setting, eg.:

TEMPLATE_CONTEXT_PROCESSORS = (
        'django.contrib.auth.context_processors.auth',
        'django.core.context_processors.debug',
        'django.core.context_processors.i18n',
        'django.core.context_processors.media',
        'django.core.context_processors.request',
        'django.core.context_processors.static',
        'django.core.context_processors.tz',
        'django.contrib.messages.context_processors.messages'
    )

Note

If you don’t have this setting defined, just add it to your settings module.

  1. {% load cookielaw_tags %} and add {% cookielaw_banner %} template tag where you want to display the cookielaw banner. Best place for this is your ‘base’ template, so you will have the cookie banner on every page of your website.

Configuration

If you want to use our default template, add cookielaw/css/cookielaw.css to the markup and you should see the cookie law banner at the top of the page until you dismiss it with the button in the top-right. This CSS is Twitter Bootstrap compatible, but chances are, you’ll like to adjust it anyway.

To change the markup, just add a template named cookielaw/banner.html and make sure it is loaded before the default template (for example put the django.template.loaders.filesystem.Loader before django.template.loaders.app_directories.Loader and add your new template to any of the TEMPLATE_DIRS).

To change the CSS, just write your own rules and don’t include the default stylesheet.

Bugs & Contribution

Please use Github to report bugs, feature requests and submit your code: http://github.com/TyMaszWeb/django-cookie-law

author:Piotr Kilczuk
date:2013/04/08

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-cookie-law-2.0.1.tar.gz (12.3 kB) Copy SHA256 hash SHA256 Source None Apr 4, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page