Pinax Web Analytics

About Pinax
Important Links
Overview
- Supported Django and Python Versions
Documentation
- Installation
- Usage
- Settings
- Templates
Change Log
Contribute
Code of Conduct
Connect with Pinax
License

About Pinax

Pinax is an open-source platform built on the Django Web Framework. It is an ecosystem of reusable Django apps, themes, and starter project templates. This collection can be found at http://pinaxproject.com.

Important Links

Where you can find what you need:

Releases: published to PyPI or tagged in app repos in the Pinax GitHub organization
Global documentation: Pinax documentation website
App specific documentation: app repos in the Pinax GitHub organization
Support information: SUPPORT.md file in the Pinax default community health file repo
Contributing information: CONTRIBUTING.md file in the Pinax default community health file repo
Current and historical release docs: Pinax Wiki

pinax-webanalytics

Overview

pinax-webanalytics provides analytics and metrics integration for Django.

Current analytics services supported:

Google Analytics
Mixpanel
gaug.es
Google AdWords Conversion Tracking

Supported Django and Python Versions

Django / Python	3.6	3.7	3.8
2.2	*	*	*
3.0	*	*	*

Documentation

Installation

To install pinax-webanalytics:

$ pip install pinax-webanalytics

Add pinax.webanalytics to your INSTALLED_APPS setting:

INSTALLED_APPS = [
    # other apps
    "pinax.webanalytics",
]

See the list of settings to modify pinax-webanalytics's default behavior and make adjustments for your website.

Usage

Integrating pinax-webanalytics is quite simple:

    {% load pinax_webanalytics_tags %}

and then toward the bottom of the body where you put your scripts:

    {% analytics %}

If you want to add certain specific activities you can use the activity API in pinax-webanalytics like so:

from pinax.webanalytics import activity

activity.add(request, "mixpanel", "track", "Node Viewed", {
    "node": self.get_object().title,
    "user": request.user.username
})

You would typically want to call this within a view where you had some activity you wanted to track that was more transactional than could be determined by simply a certain page view.

The parameters for this are the request, the kind, then the method that is used on the kind's javascript API, followed by a list of args that will be passed to that javascript API.

AdWords Conversion Tracking

Load the template tags as above:

    {% load pinax_webanalytics_tags %}

then toward the bottom of the body, include:

    {% adwords_conversion "waitinglist" %}

where the argument passed to adwords_conversion is the key used in PINAX_WEBANALYTICS_ADWORDS_SETTINGS to provide the conversion id, label and format.

Settings

PINAX_WEBANALYTICS_ADWORDS_SETTINGS

This sets the conversion identifiers for AdWords for the conversions you want to track indexed by page specific keys:

PINAX_WEBANALYTICS_ADWORDS_SETTINGS = {
    "waitinglist": {
        "conversion_id": "",
        "conversion_label": "",
        "conversion_format": ""
    }
}

PINAX_WEBANALYTICS_SETTINGS

This is a data structure defining your analytics and metrics settings indexed by settings.SITE_ID (or request.pwa_site_id.) Example:

PINAX_WEBANALYTICS_SETTINGS = {
    "mixpanel": {
        1: "", # production
        2: "", # beta
    },
    "google": {
        1: "", # production
        2: "", # beta
    },
    "gauges": {
        1: "",
    }
}

where the values you would supply for each service and SITE_ID (or request.pwa_site_id) node is the identifier code for that service.

Note that, as of 1.1, the site ID keys must be integers, not strings.

Templates

pinax-webanalytics ships with templates for three services out of the box, gaug.es, Google Analytics and Mixpanel. This can be overridden in your project for customizations and likewise if there are other services you wish to use, just create a similar template under the pinax-webanalytics folder in your templates directory. The format is "_%s.html" % slug where the slug is what index the PINAX_WEBANALYTICS_SETTINGS dict with.

`_gauges.html`

This snippet is used for gaug.es

`_google.html`

This snippet is used for Google Analytics

`_mixpanel.html`

This snippet is used for Mixpanel

`_adwords_conversion.html`

This snippet is used by the adwords_conversion template tag

Change Log

5.0.0

Drop Django 1.11, 2.0, and 2.1, and Python 2,7, 3.4, and 3.5 support
Add Django 2.2 and 3.0, and Python 3.6, 3.7, and 3.8 support
Update packaging configs
Direct users to community resources

4.0.2

Add django>=1.11 requirement
Update CI configuration
Improve documentation markup

4.0.1

Fix setup.py LONG_DESCRIPTION for PyPi

4.0.0

Add Django 2.0 compatibility testing
Drop Django 1.8, 1.9, 1.10 and Python 3.3 support
Convert CI and coverage to CircleCi and CodeCov
Add PyPi-compatible long description
Move documentation to README.md

3.0.0

use plain dict instead of template.Context

2.0.4

updated this change log

2.0.3

fixed typo in installation instructions

2.0.2

corrected broken doc link in README

2.0.1

fixed import path

2.0

renamed to pinax-webanalytics

BI

template fragments now reside in pinax/webanalytics/
settings prefixes changed from METRON_ to PINAX_WEBANALYTICS_
request.metron_site_id changed to request.pwa_site_id, but still defaults to settings.SITE_ID if not on request object
the session key name now defaults to _pwa_activity instead of _metron_activity

1.3

site ID keys in METRON_SETTINGS can reference the value stored in request.metron_site_id (useful for multi-tenancy setups)

1.2

Upgraded mixpanel

1.1

SITE_ID is now always treated as an int on lookup so the keys in METRON_SETTINGS must be ints
analytics template tag now bails out silently if user or request are missing from context

1.0

same as 0.2

0.2

added activity tracking
added adwords conversion tracking (per page template tag)

0.1

initial release

Contribute

Contributing information can be found in the Pinax community health file repo.

Code of Conduct

In order to foster a kind, inclusive, and harassment-free community, the Pinax Project has a Code of Conduct. We ask you to treat everyone as a smart human programmer that shares an interest in Python, Django, and Pinax with you.