Analytics snippets generator extension for the Flask framework.

Mihir

Last update: Nov 30, 2022

Related tags

Flask Flask-Analytics

Overview

Flask-Analytics

Flask Analytics is an extension for Flask which generates analytics snippets for inclusion in templates.

Installation

$ pip install Flask-Analytics

Usage

app.py

from flask import Flask, render_template
from flask_analytics import Analytics

app = Flask(__name__)
Analytics(app)

app.config['ANALYTICS']['GAUGES']['SITE_ID'] = 'XXXXXXXXXXXXX'


@app.route('/')
def index():

    return render_template('index.html')

index.html

{{ analytics }}

result

$ curl http://localhost:5000/
<script type="text/javascript">
    var _gauges = _gauges || [];
    (function() {
        var t   = document.createElement('script');
        t.type  = 'text/javascript';
        t.async = true;
        t.id    = 'gauges-tracker';
        t.setAttribute('data-site-id', 'XXXXXXXXXXXXX');
        t.src = '//secure.gaug.es/track.js';
        var s = document.getElementsByTagName('script')[0];
        s.parentNode.insertBefore(t, s);
    })();
</script>

Services

Flask-Analytics uses keys defined in app.config['ANALYTICS'] to determine which for which services analytics snippets should be generated.

Service	Keys Required
Google Analytics (ga.js)	`['GOOGLE_CLASSIC_ANALYTICS']['ACCOUNT']`
Universal Analytics (analytics.js)	`['GOOGLE_UNIVERSAL_ANALYTICS']['ACCOUNT']`
Piwik	`['PIWIK']['BASE_URL']` `['PIWIK']['SITE_ID']`
Gaug.es	`['GAUGES']['SITE_ID']`
Chartbeat	`['CHARTBEAT']['UID']` `['CHARTBEAT']['DOMAIN']`
GoSquared	`['GOSQUARED']['UID']`

Individual services can be disabled by setting the ENABLED key for that service (e.g. ['ANALYTICS']['PIWIK']['ENABLED']). Analytics as a whole can be disabled by setting the ENABLED key at the top (e.g. ['ANALYTICS']['ENABLED']).

When a service, or analytics as a whole, is disabled, it returns an empty string, so it's safe to keep {{analytics}} in your template.

When the configuration changes, the source for the analytics code will automatically be rebuilt the next time it's called.

Tests

$ nosetests -v --with-coverage --cover-package=flask_analytics --cover-html 
test_all (test_app.TestAnalytics) ... ok
test_boostrap (test_app.TestAnalytics) ... ok
test_chartbeat (test_app.TestAnalytics) ... ok
test_disabled (test_app.TestAnalytics) ... ok
test_gauges (test_app.TestAnalytics) ... ok
test_google_classic (test_app.TestAnalytics) ... ok
test_google_universal (test_app.TestAnalytics) ... ok
test_gosquared (test_app.TestAnalytics) ... ok
test_none (test_app.TestAnalytics) ... ok
test_piwik (test_app.TestAnalytics) ... ok

Name                                                    Stmts   Miss  Cover   Missing
-------------------------------------------------------------------------------------
flask_analytics.py                                          1      0   100%   
flask_analytics/analytics.py                               60      1    98%   77
flask_analytics/providers.py                                0      0   100%   
flask_analytics/providers/base.py                           2      0   100%   
flask_analytics/providers/chartbeat.py                     13      0   100%   
flask_analytics/providers/gauges.py                        11      0   100%   
flask_analytics/providers/googleclassicanalytics.py        11      0   100%   
flask_analytics/providers/googleuniversalanalytics.py      11      0   100%   
flask_analytics/providers/gosquared.py                     11      0   100%   
flask_analytics/providers/piwik.py                         13      0   100%   
-------------------------------------------------------------------------------------
TOTAL                                                     133      1    99%   
----------------------------------------------------------------------
Ran 10 tests in 0.111s


OK

License

Flask-Analytics is dedicated to the public domain. Please read the license for more information.

Comments

Testing in app

This is not a bug report, but a request for clarification.

I've installed Flask-Analytics in my app using pip.

I have add GOOGLE_ANALYTICS_ID in app.config.

I have included {{ analytics }} in the body of my index.html template.

I was expecting to see some interesting new text inserted into my html output, but I note no differences.

What should I expect to see in my html output, if anything?

opened by kphretiq 8
Python3 version out of date, documentation doesn't work

It's not appararent from the website that the python2 and python3 versions are completely different, even though they have the same version number. For instance, the python version is using the older out of data Google Analytics, and is using it with different keys than the python 2 version.

opened by tedivm 4
Python 3 compatibility

You nearly had it.

my_function.__code__ is backwards compatible (at least to 2.7)

The order of the js snippets isn't important, only their content is. For whatever reason, Py3 orders them differently.

str(expected.encode('utf8')) is needed since UTF8 and ascii sort differently.

opened by samizdis 2