Django''s application for handling privacy and cookie policies configured with Iubenda.
Project description
django-iubenda
GitHub
Test
Compliance for websites and apps
Click here and get 10% discount on first year at Iubenda
Check Demo Project
- Check the demo repo on GitHub
Requirements
- Python +3.8 supported.
- Django +3.2 supported.
Setup
- Install from pip:
pip install django-iubenda
- Modify
settings.py
by adding the app toINSTALLED_APPS
:
INSTALLED_APPS = (
"modeltranslation",
# ...
"iubenda",
# ...
)
- Modify
settings.py
by adding the app's context processor toTEMPLATES
:
TEMPLATES = [
{
# ...
"OPTIONS": {
"context_processors": [
# ...
"iubenda.context_processors.iubenda",
# ...
],
},
},
]
- Be sure the Django's Locale middleware is enabled inside
settings.py
:
MIDDLEWARE = (
# ...
"django.middleware.locale.LocaleMiddleware",
# ...
)
- Modify
url.py
by adding the app's urls tourlpatterns
:
urlpatterns += [
path("", include("iubenda.urls")),
]
- Modify
url.py
by adding the app's sitemaps tositemaps
:
from iubenda.sitemaps import PrivacySitemap, CookieSitemap
sitemaps = {
# ...
"privacy": PrivacySitemap,
"cookie": CookieSitemap,
# ...
}
- Be sure the variable
LANGUAGE_CODE
is available for HTML templates:
{% load i18n %}
{% get_current_language as LANGUAGE_CODE %}
- Modify your project's template to add privacy and cookie policies.
For example inside the
footer.html
add following code:
{% if not debug %}
{% block iubenda %}{% include "iubenda/include-content.html" %}{% endblock iubenda %}
{% endif %}
Optional
Content Security Policy
If Content Security Policy are implemented in your server and inline scripts are disabled,
the variable IUBENDA_CSP_NONCE
can be set with nonce tag will be inserted script's nonce.
<script type="text/javascript" {% if cx_iubenda_nonce %}nonce="{{ cx_iubenda_nonce }}"{% endif %}>
Inside your webserver's configurations, a rule to dynamically replace your CONSTANT nonce in a random string is needed.
To allow external source from Iubenda domains, please implement these rules:
Content-Security-Policy:
script-src-elem https://*.iubenda.com";
img-src https://*.iubenda.com data:";
style-src https://*.iubenda.com";
connect-src https://*.iubenda.com";
frame-src https://*.iubenda.com";
If you prefer to not allow unsafe-inline inside your CSP, please also add the two specific hash for your script prompted as error in Javascript Console.
# Iubenda Privacy And Cookie Policy - API
Content-Security-Policy:
...
script-src-elem https://*.iubenda.com 'sha256-YOUR-FIRST-HASH-PROMPTED-INSIDE-CONSOLE' 'sha256-YOUR-SECOND-HASH-PROMPTED-INSIDE-CONSOLE';
...
Check this article from Iubenda help
Iubenda's Options
(To-Do: new feuture)
To personalize the Iubenda script behaviour, the dict IUBENDA_OPTIONS
can be configured inside settings.py
IUBENDA_OPTIONS = {
"ccpaAcknowledgeOnDisplay": "true",
"ccpaApplies": "true",
"consentOnContinuedBrowsing": "false",
"enableCcpa": "true",
"floatingPreferencesButtonDisplay": "bottom-left",
"invalidateConsentWithoutLog": "true",
"perPurposeConsent": "true",
"whitelabel": "false",
"banner": {
"acceptButtonDisplay": "true",
"backgroundOverlay": "true",
"closeButtonRejects": "true",
"customizeButtonDisplay": "true",
"explicitWithdrawal": "true",
"fontSize": "14px",
"listPurposes": "true",
"position": "float-center",
"rejectButtonDisplay": "true",
},
}
Run Example Project
git clone --depth=50 --branch=django-iubenda https://github.com/DLRSP/example.git DLRSP/example
cd DLRSP/example
python manage.py runserver
Now browser the app @ http://127.0.0.1:8000
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_iubenda-1.3.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d014ebc5f30a7abbda26fae9d49d1ce8d1c2f5fa97f79d221473923777f1fff |
|
MD5 | 94753255cced33c72d3b20cec700419d |
|
BLAKE2b-256 | f58b6a181e9a5b8936ccd9541d03df98a3a3e531ecd5a5dfd448d9f86cdd61b9 |