Skip to main content

Piwik support for uData

Project description

uData-piwik

Join the chat at https://gitter.im/opendatateam/udata

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

Optional configuration

# Content tracking options. Default: None
#   - 'all': track all impressions
#   - 'visible': track impressions of visible items only (default refresh: 750 ms)
PIWIK_CONTENT_TRACKING = 'visible'

Testing on local env

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

Changelog

1.2.0 (2018-06-06)

  • Simpler and more reliable metrics computation #54

1.1.1 (2018-03-15)

  • Handle multiple resources for same url #49

1.1.0 (2018-03-13)

  • Refactor counter.handle_downloads - fix #1421

  • Switch to flask-cli and endpoint-based commands (requires udata>=1.3) #33

  • Expose the new udata.tasks endpoint #39

  • Expose the new udata.views endpoint #41

  • Add content tracking options in configuration paramaters #42

1.0.2 (2017-12-20)

  • Fix version number

  • Fix README on pypi

1.0.1 (2017-12-20)

  • Fix packaging issue

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

udata_piwik-1.2.0-py2.py3-none-any.whl (11.9 kB view hashes)

Uploaded Python 2 Python 3

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