A CKAN extension that that connects with the GBIF API.
Project description
ckanext-gbif
A CKAN extension that that connects with the GBIF API.
Overview
This extension retrieves additional data (e.g. DQIs) from the GBIF API for a record with an associated GBIF ID.
This extension also provides some templates for displaying these data.
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-gbif.git
- Activate the virtual env:
. $INSTALL_FOLDER/bin/activate
- Install the requirements from requirements.txt:
cd $INSTALL_FOLDER/src/ckanext-gbif
pip install -r requirements.txt
- Run setup.py:
cd $INSTALL_FOLDER/src/ckanext-gbif
python setup.py develop
- Add 'gbif' to the list of plugins in your
$CONFIG_FILE
:
ckan.plugins = ... gbif
Configuration
There are a couple of options to be specified in your .ini config file.
Template variables [REQUIRED]
Name | Description |
---|---|
ckanext.gbif.organisation_key |
For linking to the dataset publisher (i.e. https://gbif.org/publisher/ORG_KEY) |
ckanext.gbif.dataset_key |
For linking to the dataset itself (i.e. https://gbif.org/dataset/DATA_KEY) |
Usage
Actions
gbif_record_show
Get the associated GBIF data for a record.
from ckan.plugins import toolkit
gbif_record = toolkit.get_action(u'gbif_record_show')(context, {
u'occurrence_id': record_gbif_occurrence_id
})
Templates
The templates inherit from record/specimen.html
and record/dwc.html
and will insert a link to the GBIF view in the content_primary_nav
block.
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_gbif-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 41ebb199f38aae717f251b6c8e37210af1c5bf13e7c8552deea33271f44d6200 |
|
MD5 | 955db103aabe4303fc0e9866903cbe22 |
|
BLAKE2b-256 | 3a6dff50c296b55efbf84a93319d6b87d0b7608021d9ddf432da55713efe479c |