Skip to main content

A cookie notification banner for django-fluent-contents

Project description

https://img.shields.io/travis/edoburu/fluentcms-cookielaw/master.svg?branch=master https://img.shields.io/pypi/v/fluentcms-cookielaw.svg https://img.shields.io/pypi/l/fluentcms-cookielaw.svg https://img.shields.io/codecov/c/github/edoburu/fluentcms-cookielaw/master.svg

fluentcms-cookielaw

A plugin for django-fluent-contents to show a cookie notification on a website.

Installation

First install the module, preferably in a virtual environment. It can be installed from PyPI:

pip install fluentcms-cookielaw

Backend Configuration

First make sure the project is configured for django-fluent-contents.

Then add the following settings:

INSTALLED_APPS += (
    'fluentcms_cookielaw',
)

The database tables can be created afterwards:

./manage.py syncdb

Now, the CookieLawPlugin can be added to your PlaceholderField and PlaceholderEditorAdmin admin screens.

Frontend Configuration

Make sure that all plugin media files are exposed by django-fluent-contents:

{% load fluent_contents_tags %}

{% render_content_items_media %}

This tag should be placed at the bottom of the page, after all plugins are rendered. For more configuration options - e.g. integration with django-compressor - see the template tag documentation.

CSS Code

The stylesheet code is purposefully left out, since authors typically like to provide their own styling.

To get started quickly, include fluentcms_cookielaw/js/cookielaw.css in your site.

JavaScript Code

No configuration is required for the JavaScript integration.

By default, the plugin includes all required JavaScript code to hide the cookie notification bar.

If needed, the includes resources can be changed by using the following settings:

FLUENTCMS_COOKIELAW_JS = (
    'fluentcms_cookielaw/js/cookielaw.js',
)

If a value is defined as None, it will be excluded from the frontend media.

HTML code

If needed, the HTML code can be overwritten by redefining fluentcms_cookielaw/banner.html.

Contributing

If you like this module, forked it, or would like to improve it, please let us know! Pull requests are welcome too. :-)

Download files

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

Source Distribution

fluentcms-cookielaw-1.1.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

fluentcms_cookielaw-1.1-py2.py3-none-any.whl (14.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fluentcms-cookielaw-1.1.tar.gz.

File metadata

File hashes

Hashes for fluentcms-cookielaw-1.1.tar.gz
Algorithm Hash digest
SHA256 3f6ef76058e7dd0c90d6d794f23b1084d9c7de602e656ce912cd0833a69eaa55
MD5 3a1d52e9b4f9be591e5f790a5e8e7dba
BLAKE2b-256 f8522c8729c6085f8f81918007143e2e459d25da97a3c0e17313d92de15e5cf9

See more details on using hashes here.

File details

Details for the file fluentcms_cookielaw-1.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for fluentcms_cookielaw-1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f70027a5b3baebb06966b27e6b2a8a4022507f377c60a73cc57b7091f2058090
MD5 daa985324b2f2fd466c5d64dcf9f5da9
BLAKE2b-256 0d194f5b8ad98f15ea5b61db59acc6405cb367927e8617af7de35706ccf59997

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