udata-piwik 1.0.0.dev0

Piwik support for uData

uData-piwik

This plugin provide integration between uData and Piwik

Compatibility

udata-piwik requires Python 2.7+ and uData.

Installation

Install uData.

Remain in the same virtual environment (for Python) and use the same version of npm (for JS).

Install udata-piwik:

pip install udata-piwik

Modify your local configuration file of udata (typically, udata.cfg) as following:

PLUGINS = ['piwik']
# Tracked site id in Piwik
PIWIK_ID = 1
PIWIK_URL = 'stats.data.gouv.fr'
PIWIK_AUTH = '<32-chars-auth-token-from-piwik>'
# Mapping of piwik goals {'<name_in_udata>': <id_in_piwik>}
# All keys are required
PIWIK_GOALS = {
    'NEW_DATASET': 1,
    'NEW_REUSE': 2,
    'NEW_FOLLOW': 3,
    'SHARE': 4,
    'RESOURCE_DOWNLOAD': 5,
    'RESOURCE_REDIRECT': 6,
}
# `client.track` method `requests` timeout
PIWIK_TRACK_TIMEOUT = 60  # in seconds
# `client.analyze` method `requests` timeout
PIWIK_ANALYZE_TIMEOUT = 60 * 5  # in seconds

Testing on local env

$ docker-compose up
$ pip install -r requirements/test.pip
$ pytest

Changelog

1.0.0 (2017-12-19)

• Add (automated) tests against a Piwik instance #20

• Handle download count on latest url for (community) resources #30

0.9.3 (2017-12-11)

• Add a timeout to analyze() #19

0.9.2 (2017-12-11)

• Add a timeout to track() #18

0.9.1 (2017-01-10)

• Fix build and packaging

0.9.0 (2017-01-10)

• First published release