Skip to content
master
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
bin
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

ckanext-nhm

Travis Coveralls CKAN Specimen records

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

Installation is not going to be useful for anyone not working on the Data Portal, but the steps are left here for reference.

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-nhm.git
  1. Activate the virtual env:
. $INSTALL_FOLDER/bin/activate
  1. Install the requirements from requirements.txt:
cd $INSTALL_FOLDER/src/ckanext-nhm
pip install -r requirements.txt
  1. Run setup.py:
cd $INSTALL_FOLDER/src/ckanext-nhm
python setup.py develop
  1. Add 'nhm' to the list of plugins in your $CONFIG_FILE:
ckan.plugins = ... nhm

Configuration

These are the options that can be specified in to configure this extension.

[REQUIRED]

Name Description Options
ckanext.nhm.specimen_resource_id ID for the specimens dataset
ckanext.nhm.indexlot_resource_id ID for the index lots dataset
ckanext.nhm.artefact_resource_id ID for the artefacts dataset
ckanext.nhm.abyssline_resource_id ID for the abyssline dataset
ckanext.nhm.mam.username Username for the Museum's image server
ckanext.nhm.mam.password Password for the Museum's image server

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
)

download_original_image

Request original image from the Museum's image server.

from ckan.plugins import toolkit

data_dict = {
                'resource_id': RESOURCE_ID,
                'record_id': RECORD_ID,
                'asset_id': IMAGE_ID,
                'email': REQUESTER_EMAIL
            }

toolkit.get_action('download_original_image')(
    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

dataset-category

For managing dataset categories.

  1. create-vocabulary: create vocabulary for dataset categories

    paster --plugin=ckanext-nhm dataset-category create-vocabulary -c $CONFIG_FILE
  2. add-category: add $CATEGORY_NAME to the vocabulary

    paster --plugin=ckanext-nhm dataset-category add-category $CATEGORY_NAME -c $CONFIG_FILE
  3. delete-category: remove $CATEGORY_NAME from the vocabulary

    paster --plugin=ckanext-nhm dataset-category delete-category $CATEGORY_NAME -c $CONFIG_FILE

datastore

For modifying CKAN datastore resources.

  1. purge-all: delete all datasets and datastore tables

    paster --plugin=ckanext-nhm datastore purge-all -c $CONFIG_FILE
  2. replace: replace a datastore table with another table by changing the name of $RESOURCE_ID to $TABLE_NAME

    paster --plugin=ckanext-nhm datastore replace -i $RESOURCE_ID -t $TABLE_NAME -c $CONFIG_FILE

file

For modifying files in the datastore.

  1. replace: replace the file $RESOURCE_ID with $FILE_PATH, e.g. to replace a small dummy file with a large one that was too big to upload initially.
    paster --plugin=ckanext-nhm file replace -r $RESOURCE_ID -p $FILE_PATH -c $CONFIG_FILE

Testing

Test coverage is currently extremely limited.

To run the tests, use nosetests inside your virtualenv. The --nocapture flag will allow you to see the debug statements.

nosetests --ckan --with-pylons=$TEST_CONFIG_FILE --where=$INSTALL_FOLDER/src/ckanext-nhm --nologcapture --nocapture
You can’t perform that action at this time.