Piwik support for uData
Project description
uData-piwik
.. image:: https://badges.gitter.im/Join%20Chat.svg :target: https://gitter.im/opendatateam/udata :alt: 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:
.. code-block:: shell
pip install udata-piwik
Modify your local configuration file of udata (typically, udata.cfg
) as following:
.. code-block:: python
PLUGINS = ['piwik']
# Tracked site id in Piwik
PIWIK_ID = 1
PIWIK_SCHEME = 'https'
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
.. code-block:: python
# 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
.. code-block:: shell
$ docker-compose up
$ pip install -r requirements/test.pip
$ pytest
.. _circleci-url: https://circleci.com/gh/opendatateam/udata-piwik .. _circleci-badge: https://circleci.com/gh/opendatateam/udata-piwik.svg?style=shield .. _gitter-badge: https://badges.gitter.im/Join%20Chat.svg .. _gitter-url: https://gitter.im/opendatateam/udata .. _uData: https://github.com/opendatateam/udata
Changelog
1.4.0 (2019-03-27)
- Consolidate and expose default settings
#119 <https://github.com/opendatateam/udata-piwik/pull/119>
_ - Process API calls in bulk
#120 <https://github.com/opendatateam/udata-piwik/pull/120>
_
1.3.2 (2019-01-14)
- Add
PIWIK_SCHEME
config support#104 <https://github.com/opendatateam/udata-piwik/pull/104>
_
1.3.1 (2018-11-05)
- Ensure JS goals handling waits for
uData
object to be present#91 <https://github.com/opendatateam/udata-piwik/pull/91>
_
1.3.0 (2018-10-11)
- Advanced search tracking: display results count and categories (datasets, reuses, organizations)
#88 <https://github.com/opendatateam/udata-piwik/pull/88>
_ - Lower jobs piriority to
low
#90 <https://github.com/opendatateam/udata-piwik/pull/90>
_ - Depends on
udata>=1.6.1
1.2.0 (2018-06-06)
- Simpler and more reliable metrics computation
#54 <https://github.com/opendatateam/udata-piwik/pull/54>
_
1.1.1 (2018-03-15)
- Handle multiple resources for same url
#49 <https://github.com/opendatateam/udata-piwik/pull/49>
_
1.1.0 (2018-03-13)
- Refactor
counter.handle_downloads
- fix#1421 <https://github.com/opendatateam/udata/issues/1421>
_ - Switch to
flask-cli
and endpoint-based commands (requiresudata>=1.3
)#33 <https://github.com/opendatateam/udata-piwik/pull/33>
_ - Expose the new
udata.tasks
endpoint#39 <https://github.com/opendatateam/udata-piwik/pull/39>
_ - Expose the new
udata.views
endpoint#41 <https://github.com/opendatateam/udata-piwik/pull/41>
_ - Add content tracking options in configuration paramaters
#42 <://github.com/opendatateam/udata-piwik/pull/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 <https://github.com/opendatateam/udata-piwik/issues/20>
_ - Handle download count on latest url for (community) resources
#30 <https://github.com/opendatateam/udata-piwik/pull/30>
_
0.9.3 (2017-12-11)
- Add a timeout to
analyze()
#19 <https://github.com/opendatateam/udata-piwik/pull/19>
_
0.9.2 (2017-12-11)
- Add a timeout to
track()
#18 <https://github.com/opendatateam/udata-piwik/pull/18>
_
0.9.1 (2017-01-10)
- Fix build and packaging
0.9.0 (2017-01-10)
- First published release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for udata_piwik-1.4.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54d6a6b373e2cff8d1de6dd919a6daac47d720d742f6a835de96399a653beaea |
|
MD5 | c80481de91d581dc9bd943ca80000bd2 |
|
BLAKE2b-256 | b7aed1513b228df742a300989127ea50fd42550c47baff74ad37eb99c0e5722a |