ckanext-statistics 3.0.0

A CKAN extension for accessing instance statistics.

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

1. Clone the repository into the src folder:

cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-statistics.git

2. Activate the virtual env:

. $INSTALL_FOLDER/bin/activate

3. Install the requirements from requirements.txt:

cd $INSTALL_FOLDER/src/ckanext-statistics
pip install -r requirements.txt

4. Run setup.py:

cd $INSTALL_FOLDER/src/ckanext-statistics
python setup.py develop

5. Add 'statistics' to the list of plugins in your $CONFIG_FILE:

ckan.plugins = ... statistics

Configuration

These are no configuration options for this extension.

Usage

Actions

download_statistics

Statistics for downloads of datasets from the instance.

from ckan.plugins import toolkit

# all of these filters are optional
data_dict = {
                'resource_id': RESOURCE_ID,
                'year': YEAR,
                'month': MONTH
            }

toolkit.get_action('download_statistics')(
    context,
    data_dict
)

dataset_statistics

Statistics for dataset records.

from ckan.plugins import toolkit

# these filters are optional
data_dict = {
                'resource_id': RESOURCE_ID,
            }

toolkit.get_action('dataset_statistics')(
    context,
    data_dict
)

Commands

statistics

1. initdb: initialise the database model

    ckan -c $CONFIG_FILE statistics initdb
   

2. gbif: retrieve download statistics from GBIF.

   ckan -c $CONFIG_FILE statistics gbif
   

Testing

There is a Docker compose configuration available in this repository to make it easier to run tests.

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

1. Build the required images

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.

docker-compose run ckan

The ckan image uses the Dockerfile in the docker/ folder.