Skip to main content

A cookie notification banner for django-fluent-contents

Project description

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 frontend_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. :-)

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

fluentcms-cookielaw-1.0.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

fluentcms_cookielaw-1.0-py2.py3-none-any.whl (13.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for fluentcms-cookielaw-1.0.tar.gz
Algorithm Hash digest
SHA256 1349bcd4e09842dfa07dcdf54d91c78a70469915e34672801677686e07fd5579
MD5 fab46f4d4ed3299dc123aac7ea382752
BLAKE2b-256 1a999410106196327087ff2f275b32baa31891725a0cca47c55d9a060819d512

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fluentcms_cookielaw-1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e8f55e83df1e3651303bdc2e167bbe20caf6c80fb727d1f184bf254ae2d93d51
MD5 9e73f35a03fa12d1fa47ccf93a9e1f80
BLAKE2b-256 f4ec80785f2762836d2f71661ad587bb3545af59eb951e0d4d6fb498b02c3a9a

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