ckanext-statistics

A CKAN extension for accessing instance statistics.

Overview

Shows statistics for datasets and downloads on the CKAN instance.

NB: This extension currently only works with the Natural History Museum's theme extension ckanext-nhm.

Installation

Path variables used below: - $INSTALL_FOLDER (i.e. where CKAN is installed), e.g. /usr/lib/ckan/default - $CONFIG_FILE, e.g. /etc/ckan/default/development.ini

Installing from PyPI

shell pip install ckanext-statistics

Installing from source

1. Clone the repository into the src folder: shell cd $INSTALL_FOLDER/src git clone https://github.com/NaturalHistoryMuseum/ckanext-statistics.git

2. Activate the virtual env: shell . $INSTALL_FOLDER/bin/activate

3. Install via pip: shell pip install $INSTALL_FOLDER/src/ckanext-statistics

Installing in editable mode

Installing from a pyproject.toml in editable mode (i.e. pip install -e) requires setuptools>=64; however, CKAN 2.9 requires setuptools==44.1.0. See our CKAN fork for a version of v2.9 that uses an updated setuptools if this functionality is something you need.

Post-install setup

1. Add 'statistics' to the list of plugins in your $CONFIG_FILE: ini ckan.plugins = ... statistics

2. Upgrade the database to create the tables: shell ckan -c $CONFIG_FILE db upgrade -p statistics

Configuration

These are the options that can be specified in your .ini config file.

| Name | Description | |----------------------------------------|-----------------------------------------------------------------------------------------------------------------------| | ckanext.statistics.resource_ids | IDs of collection resources (space separated). | | ckanext.statistics.gbif_dataset_keys | GBIF dataset keys (space separated). If not specified, tries ckanext.gbif.dataset_key. Defaults to an empty string. |

Cache settings

These settings are used to directly configure a beaker cache region named ckanext_statistics. Please see their configuration docs for more information and additional options.

| Name | Description | Example | |-----------------------------------|---------------------------------------------------|----------------------------| | ckanext.statistics.cache.type | Cache backend. | ext:redis | | ckanext.statistics.cache.url | URL for the backend. | redis://localhost:6379/0 | | ckanext.statistics.cache.expire | Time until the cache content expires, in seconds. | 3600 |

Usage

Actions

download_statistics

Statistics for downloads of datasets from the instance.

```python from ckan.plugins import toolkit

all of these filters are optional

datadict = { 'resourceid': RESOURCE_ID, 'year': YEAR, 'month': MONTH }

toolkit.getaction('downloadstatistics')( context, data_dict ) ```

dataset_statistics

Statistics for dataset records.

```python from ckan.plugins import toolkit

these filters are optional

datadict = { 'resourceid': RESOURCE_ID, }

toolkit.getaction('datasetstatistics')( context, data_dict ) ```

Testing

There is a Docker compose configuration available in this repository to make it easier to run tests. The ckan image uses the Dockerfile in the docker/ folder.

To run the tests against ckan 2.9.x on Python3:

1. Build the required images: shell docker compose build

2. Then run the tests. The root of the repository is mounted into the ckan container as a volume by the Docker compose configuration, so you should only need to rebuild the ckan image if you change the extension's dependencies. shell docker compose run ckan