Skip to main content

A Django app to integrate Fathom Analytics into your project

Project description

django-usefathom

Fathom Analytics integration with Django projects. Provides ability to integrate page view tracking and goal reporting.

If you want to track goals instead of events, please use the 1.x.x version of the library.

Installation

Install the package:

pip install django-usefathom

Add usefathom to your settings.py file:

INSTALLED_APPS = [
    # ...
    "usefathom",
    # ...
]

Add template processor to your settings.py file:

TEMPLATES = [
    {
        # ....
        "OPTIONS": {
            "context_processors": [
                # ...
                "usefathom.context_processors.usefathom",
                # ...
            ],
        },
    },
]

Add your fathom site id to your settings.py file:

FATHOM_SITE_ID = "XXXX1234"

Include tracking snippet in your templates:

{% include "usefathom/usefathom.html" %}

From this point your site visits will be tracked.

Event Tracking

Python

Now if you want to report a event from your backend service to Fathom analytics:

import usefathom

def some_view(request, *args, **kwargs):
    # anywhere you have request object, most likely views are a good place for this
    usefathom.track(request, "add_to_card", 100)  # Third parameter is optional integer, attaches the monetary value to the event in cents

And the goal will be reported to Fathom analytics on the next page load.

HTML+JS

You can use template tags to track the goals from the html. It's useful when tracking external link clicks, etc.

{% load fathom }
......with link
<a href="https://go-somewhere.com/link" {% click_event "somewhere_link_clicked" 100 %}>Go somewhere?</a>
......with form
<form method="POST" {% submit_event "registration_submit" %}>

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_usefathom-2.0.3.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

django_usefathom-2.0.3-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file django_usefathom-2.0.3.tar.gz.

File metadata

  • Download URL: django_usefathom-2.0.3.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.9 Linux/6.7.11-orbstack-00143-ge6b82e26cd22

File hashes

Hashes for django_usefathom-2.0.3.tar.gz
Algorithm Hash digest
SHA256 bb852d07060173aabd2d19ae9190b79e8dff8cb0f6f212eff82b1d7514e76f72
MD5 c66f9bda988672fa224e8c8e16ce8e2b
BLAKE2b-256 efc9984d84f0a0b14aafec02c608361011f9e40abe06ec1e03af58474b86a6ca

See more details on using hashes here.

File details

Details for the file django_usefathom-2.0.3-py3-none-any.whl.

File metadata

  • Download URL: django_usefathom-2.0.3-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.9 Linux/6.7.11-orbstack-00143-ge6b82e26cd22

File hashes

Hashes for django_usefathom-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 01357777861bd543a3c1659776c44c99a47a8fdb02fcc90df776ca6e2c2f796d
MD5 10c6785a6aae5affc46cfed5c2b1b049
BLAKE2b-256 5e93a4facca7f5a6e9fb46bdd18b8818f6d831a7c7d5284e63b8530ec2a1c5ba

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