Data

Tools

Indexes

Applications

Experiments

Open Source Science

ckanext-gbif

A CKAN extension that that connects with the GBIF API.

https://github.com/naturalhistorymuseum/ckanext-gbif

Science Score: 62.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 5 committers (20.0%) from academic institutions
  • ✓
    Institutional organization owner
    Organization naturalhistorymuseum has institutional domain (www.nhm.ac.uk)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.8%) to scientific vocabulary

Keywords

ckan ckan-extension gbif

Keywords from Contributors

sketchfab
Last synced: 6 months ago · JSON representation ·

Repository

A CKAN extension that that connects with the GBIF API.

Basic Info
  • Host: GitHub
  • Owner: NaturalHistoryMuseum
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 248 KB
Statistics
  • Stars: 4
  • Watchers: 9
  • Forks: 1
  • Open Issues: 0
  • Releases: 18
Topics
ckan ckan-extension gbif
Created about 11 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Support

README.md

The Natural History Museum logo.

ckanext-gbif

Tests Coveralls CKAN Python Docs

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

Installing from PyPI

shell pip install ckanext-gbif

Installing from source

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

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

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

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 'gbif' to the list of plugins in your $CONFIG_FILE: ini ckan.plugins = ... gbif

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

Configuration

These are the options that can 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/ORGKEY) | | `ckanext.gbif.datasetkey` | 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.

```python from ckan.plugins import toolkit

gbifrecord = toolkit.getaction(u'gbifrecordshow')(context, { u'occurrenceid': recordgbifoccurrenceid }) ```

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

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

Owner

  • Name: Natural History Museum
  • Login: NaturalHistoryMuseum
  • Kind: organization
  • Location: London

Citation (CITATION.cff) 

cff-version: 1.2.0
title: CKAN Gbif extension
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - name: Natural History Museum
    city: London
    country: GB
    alias: NHM
    email: data@nhm.ac.uk
repository-code: 'https://github.com/NaturalHistoryMuseum/ckanext-gbif'
abstract: A CKAN extension that that connects with the GBIF API.
keywords:
  - ckan
  - ckanext
  - gbif
license: GPL-3.0-or-later
version: 2.1.12

GitHub Events

Total
  • Release event: 1
  • Delete event: 5
  • Issue comment event: 2
  • Push event: 18
  • Pull request event: 11
  • Create event: 6
Last Year
  • Release event: 1
  • Delete event: 5
  • Issue comment event: 2
  • Push event: 18
  • Pull request event: 11
  • Create event: 6

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 145
  • Total Committers: 5
  • Avg Commits per committer: 29.0
  • Development Distribution Score (DDS): 0.628
Past Year
  • Commits: 23
  • Committers: 3
  • Avg Commits per committer: 7.667
  • Development Distribution Score (DDS): 0.304
Top Committers
Name Email Commits
Alice Butcher a****i@g****m 54
benscott b****n@b****k 54
Josh Humphries j****s@n****k 27
github-actions[bot] g****] 9
Alice Heaton a****5@g****m 1
Committer Domains (Top 20 + Academic)
nhm.ac.uk: 1 benscott.co.uk: 1

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 0
  • Total pull requests: 44
  • Average time to close issues: N/A
  • Average time to close pull requests: 14 days
  • Total issue authors: 0
  • Total pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 0.2
  • Merged pull requests: 44
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 9
  • Average time to close issues: N/A
  • Average time to close pull requests: about 3 hours
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.33
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • alycejenni (38)
  • jrdh (12)
  • benscott (2)
Top Labels
Issue Labels
Pull Request Labels
enhancement (1) bug (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 321 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 0
  • Total versions: 14
  • Total maintainers: 1
pypi.org: ckanext-gbif

A CKAN extension that that connects with the GBIF API.

  • Versions: 14
  • Dependent Packages: 1
  • Dependent Repositories: 0
  • Downloads: 321 Last month
Rankings
Dependent packages count: 2.9%
Downloads: 10.6%
Average: 18.6%
Forks count: 23.2%
Stargazers count: 25.5%
Dependent repos count: 30.6%
Maintainers (1)
nhm-data
Last synced: 7 months ago

Dependencies

setup.py pypi
  • python-dateutil *
  • requests *
.github/workflows/bump.yml actions
  • actions/checkout v3 composite
  • commitizen-tools/commitizen-action master composite
  • softprops/action-gh-release v1 composite
.github/workflows/main.yml actions
  • actions/checkout v3 composite
.github/workflows/pypi-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
docker/Dockerfile docker
  • naturalhistorymuseum/ckantest 0.2 build
docker-compose.yml docker
  • ckan/ckan-solr 2.9
  • redis latest
docs/requirements.txt pypi
  • mkdocs *
  • mkdocs-gen-files *
  • mkdocs-include-markdown-plugin *
  • mkdocs-material *
  • mkdocs-section-index *
  • mkdocstrings *
pyproject.toml pypi
  • ckantools >=0.3.0
  • python-dateutil *
  • requests *