A CKAN extension for the Natural History Museum's Data Portal.
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.
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
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
pip install ckanext-nhm
-
Clone the repository into the
src
folder:cd $INSTALL_FOLDER/src git clone https://github.com/NaturalHistoryMuseum/ckanext-nhm.git
-
Activate the virtual env:
. $INSTALL_FOLDER/bin/activate
-
Install via pip:
pip install $INSTALL_FOLDER/src/ckanext-nhm
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.
-
Add 'nhm' to the list of plugins in your
$CONFIG_FILE
:ckan.plugins = ... nhm
-
Install
lessc
globally:npm install -g "less@~4.1"
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
)
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
)
Ensures the default dataset vocabulary and categories exists.
ckan -c $CONFIG_FILE nhm create-dataset-vocabulary
Adds the given category to the dataset category vocabulary.
ckan -c $CONFIG_FILE nhm delete-dataset-category $NAME
Deletes the given dataset category from the vocabulary.
ckan -c $CONFIG_FILE nhm create-dataset-vocabulary $NAME
Replaces the file associated with $RESOURCE_ID
with $PATH
, e.g. to replace a small dummy file
with a large one that was too big to upload initially.
ckan -c $CONFIG_FILE nhm replace-resource-file $RESOURCE_ID $PATH
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:
-
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