These CKAN Versions are exactely matched:

• 2.10.0
• 2.10.1
• 2.10.2
• 2.10.3
• 2.10.4
• 2.10.5
• 2.10.6
• 2.10.7
• 2.10.8
• 2.10.9
• 2.11.0
• 2.11.1
• 2.11.2
• 2.11.3
• 2.11.4
• 2.12.0
• 2.9.0
• 2.9.0a
• 2.9.1
• 2.9.10
• 2.9.11
• 2.9.13
• 2.9.2
• 2.9.3
• 2.9.4
• 2.9.5
• 2.9.6
• 2.9.7
• 2.9.8
• 2.9.9

ckanext-nhm

A CKAN extension for the Natural History Museum’s Data Portal.

Overview

This extension provides theming and specific functionality for the Natural History Museum’s Data Portal.

The codebase shows how to implement various plugins created by the Museum’s developers; notably our new ElasticSearch datastore with versioned records.

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

Pre-install setup

This package depends on ckanext-dcat==1.3.0, but since that isn’t available on PyPI it’s not listed in the package dependencies.

Install it with:

pip install git+https://github.com/ckan/ckanext-dcat@v1.3.0#egg=ckanext-dcat

Installing from PyPI

pip install ckanext-nhm

Installing from source

1. Clone the repository into the src folder:

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

2. Activate the virtual env:

   . $INSTALL_FOLDER/bin/activate
   

3. Install via pip:

   pip install $INSTALL_FOLDER/src/ckanext-nhm
   

Post-install setup

1. Add ‘nhm’ to the list of plugins in your $CONFIG_FILE:

   ckan.plugins = ... nhm
   

2. Install lessc globally:

   npm install -g "less@~4.1"
   

Usage

Actions

record_show

Retrieve an individual record.

from ckan.plugins import toolkit

data_dict = {
    'resource_id': RESOURCE_ID,
    'record_id': RECORD_ID,
    'version': OPTIONAL_RECORD_VERSION
}

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

object_rdf

Get record RDF from its occurrence ID.

from ckan.plugins import toolkit

data_dict = {
    'uuid': OCCURRENCE_ID,
    'version': OPTIONAL_RECORD_VERSION
}

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

Commands

create-dataset-vocabulary

Ensures the default dataset vocabulary and categories exists.

ckan -c $CONFIG_FILE nhm create-dataset-vocabulary

add-dataset-category

Adds the given category to the dataset category vocabulary.

ckan -c $CONFIG_FILE nhm add-dataset-category $NAME

delete-dataset-category

Deletes the given dataset category from the vocabulary.

ckan -c $CONFIG_FILE nhm delete-dataset-category $NAME

replace-resource-file

Replaces the file associated with $RESOURCE_ID with $PATH.

ckan -c $CONFIG_FILE nhm replace-resource-file $RESOURCE_ID $PATH

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:

   docker compose build
   

2. Then run the tests:

   docker compose run --rm ckan