Matomo analytics for CKAN
Project description
ckanext-matomo
Requirements
For example, you might want to mention here which versions of CKAN this extension works with.
Installation
To install ckanext-matomo:
Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate
Install the ckanext-matomo Python package into your virtual environment:
pip install ckanext-matomo
Add matomo to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini).
Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu:
sudo service apache2 reload
Config Settings
# The domain used for matomo analytics ckanext.matomo.domain = http://example.com/
# The site id used in matomo ckanext.matomo.site_id = 1
# The domain where matomo script is downloaded # (optional, default ckanext.matomo.domain) ckanext.matomo.script_domain
Development Installation
To install ckanext-matomo for development, activate your CKAN virtualenv and do:
git clone https://github.com/vrk-kpa/ckanext-matomo.git cd ckanext-matomo python setup.py develop pip install -r dev-requirements.txt
Running the Tests
To run the tests, do:
nosetests --nologcapture --with-pylons=test.ini
To run the tests and produce a coverage report, first make sure you have coverage installed in your virtualenv (pip install coverage) then run:
nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.matomo --cover-inclusive --cover-erase --cover-tests
Registering ckanext-matomo on PyPI
ckanext-matomo should be availabe on PyPI as https://pypi.python.org/pypi/ckanext-matomo. If that link doesn’t work, then you can register the project on PyPI for the first time by following these steps:
Create a source distribution of the project:
python setup.py sdist
Register the project:
python setup.py register
Upload the source distribution to PyPI:
python setup.py sdist upload
Tag the first release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py is 0.0.1 then do:
git tag 0.0.1 git push --tags
Releasing a New Version of ckanext-matomo
ckanext-matomo is availabe on PyPI as https://pypi.python.org/pypi/ckanext-matomo. To publish a new version to PyPI follow these steps:
Update the version number in the setup.py file. See PEP 440 for how to choose version numbers.
Create a source distribution of the new version:
python setup.py sdist
Upload the source distribution to PyPI:
python setup.py sdist upload
Tag the new release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py is 0.0.2 then do:
git tag 0.0.2 git push --tags
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 Distribution
File details
Details for the file ckanext-matomo-0.0.1.tar.gz
.
File metadata
- Download URL: ckanext-matomo-0.0.1.tar.gz
- Upload date:
- Size: 38.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 937183c5973c6db6dc13f61cd90be7444a00dc074bbbed6a39f235631ef6bd33 |
|
MD5 | 04e7c1eba9399c546f79a94d61f5efe1 |
|
BLAKE2b-256 | 35e8c4c5e03d92ffcbbf3cf8b75a7b958215f77068bce2342e2c76cedb0b8d87 |