Skip to main content

A cookie notification banner for django-fluent-contents

Project description

fluentcms-cookielaw

https://github.com/django-fluent/fluentcms-cookielaw/actions/workflows/tests.yaml/badge.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/django-fluent/fluentcms-cookielaw/master.svg

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

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

Uploaded Source

Built Distribution

fluentcms_cookielaw-3.0-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fluentcms-cookielaw-3.0.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6

File hashes

Hashes for fluentcms-cookielaw-3.0.tar.gz
Algorithm Hash digest
SHA256 372f2ebbbf5c304783ede5f7f89630791de7b45f0a80ab7e058fa10acfca95de
MD5 e04f3db6ae4b2292661ae208af4e6cf3
BLAKE2b-256 00e98e0ecd37360b9c1bc5c032d0ef3b95759b3543ddff08b94ba3704ae516ba

See more details on using hashes here.

File details

Details for the file fluentcms_cookielaw-3.0-py3-none-any.whl.

File metadata

  • Download URL: fluentcms_cookielaw-3.0-py3-none-any.whl
  • Upload date:
  • Size: 14.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6

File hashes

Hashes for fluentcms_cookielaw-3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ff4380da695cba69bb32acfad0a909a139640972379200b41c0b67e4610b96b3
MD5 6fc277888b5a625e8b1d2a953ef4b040
BLAKE2b-256 eba519b9f8c99c31e91a38633b5dcb2efc5709aca20b9744725e9aa42674ada3

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