Skip to main content

Django module to provide easy Plausible integration, with Wagtail support

Project description

django-plausible

CI PyPI PyPI - Python Version PyPI - Status PyPI - License

Django module to provide easy Plausible integration, with Wagtail support.

Installation

pip install django-plausible

Then simply add plausible to INSTALLED_APPS.

Usage

django-plausible provides a plausible template tag, which can be used to output the required script tag for Plausible.

{% load plausible %}

{% plausible %}

Will result in:

<script defer data-domain="example.com" src="https://plausible.io/js/plausible.js"></script>

Configuration

Configuration can be changed either in settings.py, or when calling the plausible template tag:

  • PLAUSIBLE_DOMAIN: The domain Plausible is running on (defaults to plausible.io)
  • PLAUSIBLE_SCRIPT_NAME: The name of the script to use (defaults to plausible.js). See script extensions for available options.

These settings will affect all calls to the plausible template tag. To override it at call time, you can also pass them into the template tag:

{% plausible plausible_domain="my-plausible.com" script_name="plausible.hash.js" %}

By default, the domain (data-domain) used will be based on the request's hostname (using request.get_host()). To override this, pass site_domain to the template tag.

If the "compat" script is used, django-plausible will automatically add the required id to the script tag. It is excluded by default to help hide Plausible's presence.

Usage with Wagtail

Additionally, django-plausible provides an (optional) deep integration with Wagtail, allowing configuration through the Wagtail admin. To enable this, additionally add plausible.contrib.wagtail to INSTALLED_APPS.

Configuration is done through the "Plausible Analytics" setting:

  • site_domain: the value for data-domain. If left blank (the default), the request's hostname will be used (as above), not the site hostname.
  • plausible_domain: The domain Plausible is running on (as above)
  • script_name: The name of the script to use (as above)

To access the template tag, load plausible_wagtail, rather than plausible. The template tag itself is still plausible. Note that unlike the Django variant, the Wagtail template tag doesn't allow options to be passed.

{% load plausible_wagtail %}

{% plausible %}

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

django-plausible-0.5.0.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

django_plausible-0.5.0-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file django-plausible-0.5.0.tar.gz.

File metadata

  • Download URL: django-plausible-0.5.0.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for django-plausible-0.5.0.tar.gz
Algorithm Hash digest
SHA256 c6fbeb1200a86f63cbe83f07e665202a29edeb6b46eb78b393372fb37b945330
MD5 ef62eb820b4fcb88872a5b1f49428b77
BLAKE2b-256 f0496369ba0ba1c4f767f064ed03ae48a7ac795d45f5a61ce1efb6aad623b872

See more details on using hashes here.

File details

Details for the file django_plausible-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_plausible-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d132371bafcf2b65afead0ac2eb65cf52d2e6260b22c2999c3a58d1fe60ca9b1
MD5 e43dc8629bb4ae608eeb609950bfba56
BLAKE2b-256 b1d85ff0ece31b4c97971592e7f4d43803e63eb326b5f6235827daacb534193a

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