Use Flask-Matomo

.env.example

@@ -13,4 +13,9 @@ SHIELDS_IO_BASE_URL="https://img.shields.io/"
 API_VALIDATE_ENDPOINT=http://127.0.0.1:5600/validate
 
 # Homepage sections and blocks config file path
-# HOMEPAGE_CONFIG_FILE=homepage_config.json
\ No newline at end of file
+# HOMEPAGE_CONFIG_FILE=homepage_config.json
+
+# If used, do "pip install validata-api[matomo]"
+# MATOMO_AUTH_TOKEN=""
+# MATOMO_BASE_URL=""
+# MATOMO_SITE_ID=""

requirements.txt

@@ -3,6 +3,7 @@ cachecontrol==0.12.5
 commonmark==0.8.1
 ezodf==0.3.2
 Flask==1.0.2
+Flask-Matomo==1.2.0
 lxml==4.2.5
 opendataschema==0.2.0
 python-dotenv==0.10.1

setup.py

@@ -67,4 +67,8 @@ setup(
         'opendataschema >= 0.2.0, < 0.3',
         'validata_core >= 0.3.0, < 0.4',
     ],
+
+    extras_require={
+        'matomo': ["Flask-Matomo"],
+    },
 )

validata_ui/__init__.py

@@ -4,12 +4,12 @@ import os
 from pathlib import Path
 from urllib.parse import quote_plus
 
-import cachecontrol
 import flask
 import jinja2
 import requests
 import tableschema
 
+import cachecontrol
 import opendataschema
 
 from . import config
@@ -45,6 +45,11 @@ if config.HOMEPAGE_CONFIG:
 app = flask.Flask(__name__)
 app.secret_key = config.SECRET_KEY
 
+matomo = None
+if config.MATOMO_AUTH_TOKEN and config.MATOMO_BASE_URL and config.MATOMO_SITE_ID:
+    from flask_matomo import Matomo
+    matomo = Matomo(app, matomo_url=config.MATOMO_BASE_URL,
+                    id_site=config.MATOMO_SITE_ID, token_auth=config.MATOMO_AUTH_TOKEN)
 
 # Jinja2 url_quote_plus custom filter
 # https://stackoverflow.com/questions/12288454/how-to-import-custom-jinja2-filters-from-another-file-and-using-flask

validata_ui/config.py

@@ -50,3 +50,9 @@ if HOMEPAGE_CONFIG_FILE:
     HOMEPAGE_CONFIG_FILE = Path(HOMEPAGE_CONFIG_FILE)
     with HOMEPAGE_CONFIG_FILE.open() as fd:
         HOMEPAGE_CONFIG = json.load(fd)
+
+MATOMO_AUTH_TOKEN = os.getenv("MATOMO_AUTH_TOKEN") or None
+MATOMO_BASE_URL = os.getenv("MATOMO_BASE_URL") or None
+MATOMO_SITE_ID = os.getenv("MATOMO_SITE_ID") or None
+if MATOMO_SITE_ID:
+    MATOMO_SITE_ID = int(MATOMO_SITE_ID)