ckanext-query-dois

A CKAN extension that creates DOIs for queries on resources.

Overview

This extension creates (mints) digital object identifiers (DOIs) for queries on resources. By recording the query parameters used and the exact version of the data at the time of the query, this allows precise retrieval of the data as it looked when the DOI was minted.

Can be used in conjunction with v5.2+ of ckanext-versioned-datastore.

You will need an account with a DataCite DOI service provider to use this extension.

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-query-dois

Installing from source

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

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

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

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 'querydois' to the list of plugins in your `$CONFIGFILE: ini ckan.plugins = ... query_dois `

2. Install lessc globally: shell npm install -g "less@~4.1"

3. Initialise database tables: shell ckan -c $CONFIG_FILE query-dois initdb

4. Sign up for an account with DataCite and provide the credentials in your configuration.

Configuration

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

[REQUIRED]

| Name | Description | Options | |----------------------------------------|-----------------------------------------------------------------------|---------| | ckanext.query_dois.prefix | Prefix to use for the new DOIs | | | ckanext.query_dois.datacite_username | Datacite account username | | | ckanext.query_dois.datacite_password | Datacite account password | | | ckanext.query_dois.doi_title | Template string for the DOI title: takes count as a format argument | | | ckanext.query_dois.publisher | DOI publisher name | |

Other options

| Name | Description | Options | Default | |--------------------------------|--------------------------------------------------------------|------------|---------| | ckanext.query_dois.test_mode | Enable/disable using test DOIs (i.e. not creating real DOIs) | True/False | True |

Usage

Commands

initdb

Initialises the database table.

1. initdb: initialise the database model bash ckan -c $CONFIG_FILE query-dois initdb

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