Quickstart

Django's application for handling privacy and cookie policies configured with Iubenda.

Requirements

These packages are required:

Python +3.8 supported.
Django +3.2 supported.

We highly recommend and only officially support the latest patch release of each Python and Django series.

Installation

Install from pip:
```
pip install django-iubenda
```

Modify settings.py by adding the app to INSTALLED_APPS:

INSTALLED_APPS = (
    "modeltranslation",
    # ...
    "iubenda",
    # ...
)

Modify settings.py by adding the app's context processor to TEMPLATES:

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",
    # ...
)

Optionally, but sugguested, the Django's Current Site middleware is enabled inside settings.py:

MIDDLEWARE = (
    # ...
    "django.contrib.sites.middleware.CurrentSiteMiddleware",
    # ...
)

Modify url.py by adding the app's urls to urlpatterns:

urlpatterns += [
    path("", include("iubenda.urls")),
]

Modify url.py by adding the app's sitemaps to sitemaps:

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

Autoblocking

If Iubenda autoblocking's configurations are implemented in your account, the variable IUBENDA_AUTOBLOCKING can be set to import the site's script.

<script src="https://cs.iubenda.com/autoblocking/{{ cx_iubenda.iub_site_id }}.js"></script>

Iubenda's Options

To personalize the Iubenda script's behaviour, the dict IUBENDA_OPTIONS can be configured inside settings.py

IUBENDA_OPTIONS = {
    "countryDetection": "true",
    "askConsentAtCookiePolicyUpdate": "true",
    "enableFadp": "true",
    "enableLgpd": "true",
    "lgpdAppliesGlobally": "true",
    "enableUspr": "true",
    "enableCcpa": "true",
    "ccpaAcknowledgeOnDisplay": "true",
    "ccpaApplies": "true",
    "consentOnContinuedBrowsing": "false",
    "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",
        "showPurposesToggles": "true",
    },
}

Integration with Google Tag Manager

If Google Tag Manager is implemented in your application and all needed settings were configured inside the container, the variable IUBENDA_GTM can be set with the value True and the Iubenda's callback will be inserted inside the script.

For needed configuration inside Google Tag Manager container, please refer to these notes: * Google Consent Mode * Google Consent Mode setup GTM with Iubenda * GTM Blocking Cookies

Example

Let's take a look at a quick example of using this project to build a simple App with custom error pages.

Check the demo repo on GitHub

Quickstart

Can't wait to get started? The quickstart guide is the fastest way to get up and running and building a demo App.

Customize

Do you want custom solutions? The [customize][customize] section is an overview of which part are easy to design. If you find how to personalize different scenarios or behaviors, a pull request is welcome!

Development

See the Contribution guidelines for information on how to clone the repository, run the test suite and contribute changes back to django-iubenda.

Security

If you believe you’ve found something in this project which has security implications, please do not raise the issue in a public forum.

Send a description of the issue via email to dlrsp.issue@gmail.com. The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure.

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.