A CKAN extension for accessing instance statistics.
Project description
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
- Clone the repository into the
src
folder:
cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-statistics.git
- Activate the virtual env:
. $INSTALL_FOLDER/bin/activate
- Install the requirements from requirements.txt:
cd $INSTALL_FOLDER/src/ckanext-statistics
pip install -r requirements.txt
- Run setup.py:
cd $INSTALL_FOLDER/src/ckanext-statistics
python setup.py develop
- 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
-
initdb
: initialise the database modelckan -c $CONFIG_FILE statistics initdb
-
gbif
: retrieve download statistics from GBIF.ckan -c $CONFIG_FILE statistics gbif
Testing
Test coverage is currently extremely limited.
To run the tests in this extension, there is a Docker compose configuration available in this repository to make it easy.
To run the tests against ckan 2.9.x on Python3:
- Build the required images
docker-compose build
- 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 which is based on openknowledge/ckan-dev:2.9
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for ckanext-statistics-2.0.15.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d70da18d57847655a92a1966f0319eb193a279e8b95e4883cbb373ecd0c5f5dc |
|
MD5 | 1ebb3d9118e162b0f7f42246cdc4e18c |
|
BLAKE2b-256 | f928cf57f84c06cf4eb2288cdc2675df6e793f514400d89f0698b9ec88654f5a |
Hashes for ckanext_statistics-2.0.15-py3.10.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc0c2c0a1dcd95ec43cbc89bd6b967624ba43f536b57f0581e844832c6065839 |
|
MD5 | fdbd963e964cf55bb61b98759956933f |
|
BLAKE2b-256 | 148369e80ea311e67a038e6dfacda705af7727cfaaecdb4fd78b20bf63e9a900 |
Hashes for ckanext_statistics-2.0.15-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69827309ca974150efcc974a8fc7b15f6680111ac16266556524b4e25a09ad29 |
|
MD5 | 412faf0bc76cabe2fd8b1058a684fdef |
|
BLAKE2b-256 | 060085d1ce6d3c3a33a803c484db131639e7290137992e3b6ffd999145f72838 |