Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/citruspi/Flask-Analytics
Analytics snippets generator extension for the Flask framework.
https://github.com/citruspi/Flask-Analytics
Last synced: 3 months ago
JSON representation
Analytics snippets generator extension for the Flask framework.
- Host: GitHub
- URL: https://github.com/citruspi/Flask-Analytics
- Owner: citruspi
- License: unlicense
- Created: 2014-02-20T04:38:39.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2016-10-12T18:57:38.000Z (over 8 years ago)
- Last Synced: 2024-09-18T16:56:38.323Z (4 months ago)
- Language: Python
- Size: 68.4 KB
- Stars: 79
- Watchers: 6
- Forks: 21
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-flask - Flask-Analytics - Analytics snippets generator extension for the Flask framework (Analytics)
- awesome-flask - Flask-Analytics - Analytics snippets generator extension for the Flask framework (Analytics)
- awesome-flask - Flask-Analytics - Analytics snippets generator extension for the Flask framework (Analytics)
- jimsghstars - citruspi/Flask-Analytics - Analytics snippets generator extension for the Flask framework. (Python)
README
[](https://travis-ci.org/citruspi/Flask-Analytics)
[](https://coveralls.io/github/citruspi/Flask-Analytics)
[](http://unlicense.org)
[](https://pypi.python.org/pypi/Flask-Analytics)
[](https://pypi.python.org/pypi/Flask-Analytics)
[](https://pypi.python.org/pypi/Flask-Analytics)
[](https://pypi.python.org/pypi/Flask-Analytics)
## Flask-Analytics
Flask Analytics is an extension for Flask which generates analytics snippets for inclusion in templates.
## Installation
```bash
$ pip install Flask-Analytics
```
## Usage
__app.py__
```python
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__
```html
$ curl http://localhost:5000/
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);
})();
```
## 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)](http://www.google.com/analytics/) | `['GOOGLE_CLASSIC_ANALYTICS']['ACCOUNT']` |
| [Universal Analytics (analytics.js) ](http://www.google.com/analytics/) | `['GOOGLE_UNIVERSAL_ANALYTICS']['ACCOUNT']` |
| [Piwik](http://piwik.org/) | `['PIWIK']['BASE_URL']`
`['PIWIK']['SITE_ID']`|
| [Gaug.es](http://gaug.es/) | `['GAUGES']['SITE_ID']` |
| [Chartbeat](https://chartbeat.com) | `['CHARTBEAT']['UID']`
`['CHARTBEAT']['DOMAIN']` |
| [GoSquared](https://www.gosquared.com) | `['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.