datasette-matomo by CentreForDigitalHumanities

12 downloads this week        Star

README source code

datasette-matomo

PyPI Changelog Tests License

Datasette plugin that adds Matomo Web Analytics JavaScript tracking code to a Datasette application.

Installation

Install this plugin in the same environment as Datasette.

datasette install datasette-matomo

Usage

Make your configuration available to the Datasette process as environment variables:

DATASETTE_MATOMO_SERVER_URL=https://example.com/
DATASETTE_MATOMO_SITE_ID=1

The server URL must include a final slash.

If you use datasette publish:

datasette publish heroku example.db --install datasette-matomo \
    --plugin-secret datasette-matomo server_url http://example.com/ \
    --plugin-secret datasette-matomo site_id 1

Note: not all datasette publish providers currently support the --plugin-secret option.

Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:

cd datasette-matomo
python3 -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

pytest