https://github.com/centrefordigitalhumanities/datasette-matomo

Add Matomo Web Analytics JavaScript tracking code to Datasette
https://github.com/centrefordigitalhumanities/datasette-matomo

datasette datasette-plugin matomo web-analytics

Last synced: 23 days ago
JSON representation

Add Matomo Web Analytics JavaScript tracking code to Datasette

• Host: GitHub
• URL: https://github.com/centrefordigitalhumanities/datasette-matomo
• Owner: CentreForDigitalHumanities
• License: apache-2.0
• Created: 2023-01-25T11:35:22.000Z (almost 2 years ago)
• Default Branch: develop
• Last Pushed: 2023-12-20T17:03:13.000Z (11 months ago)
• Last Synced: 2024-04-24T11:12:06.816Z (7 months ago)
• Topics: datasette, datasette-plugin, matomo, web-analytics
• Language: Python
• Homepage:
• Size: 16.6 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        
# datasette-matomo

[![PyPI](https://img.shields.io/pypi/v/datasette-matomo.svg)](https://pypi.org/project/datasette-matomo/)

[![Changelog](https://img.shields.io/github/v/release/UUDigitalHumanitieslab/datasette-matomo?include_prereleases&label=changelog)](https://github.com/UUDigitalHumanitieslab/datasette-matomo/releases)

[![Tests](https://github.com/UUDigitalHumanitieslab/datasette-matomo/workflows/Test/badge.svg)](https://github.com/UUDigitalHumanitieslab/datasette-matomo/actions?query=workflow%3ATest)

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/UUDigitalHumanitieslab/datasette-matomo/blob/main/LICENSE)

[Datasette plugin](https://datasette.io/) that adds [Matomo Web Analytics](https://matomo.org/) 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