The Natural History Museum logo.

ckanext-nhm

Tests Coveralls CKAN Python Docs 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

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

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 'nhm' to the list of plugins in your $CONFIG_FILE:

    ckan.plugins = ... nhm

  2. Install lessc globally:

    npm install -g "less@~4.1"

Configuration

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 delete-dataset-category $NAME

delete-dataset-category

Deletes the given dataset category from the vocabulary.

ckan -c $CONFIG_FILE nhm create-dataset-vocabulary $NAME

replace-resource-file

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

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. 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 --rm ckan

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for nhm-data from gravatar.com nhm-data

Credits

Author: Natural History Museum

License

GNU General Public License v3 (GPLv3) (GPL-3.0-or-later)

Requires

Python >=3.6

Provides Extra

test

Tags

CKAN data nhm

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ckanext_nhm-7.8.1.tar.gz (55.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ckanext_nhm-7.8.1-py3-none-any.whl (55.9 MB view details)

Uploaded Python 3

File details

Details for the file ckanext_nhm-7.8.1.tar.gz.

File metadata

  • Download URL: ckanext_nhm-7.8.1.tar.gz
  • Upload date:
  • Size: 55.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ckanext_nhm-7.8.1.tar.gz
Algorithm Hash digest
SHA256 24a90a4eaffc1f959b9b16e86f06a94e0ec17850a43b140c76a3e032bfbc3a5c
MD5 6493bd91f48420ae6627850c0be9f079
BLAKE2b-256 da6a613a669e80a6464f5409842a1885249bd8823b9de3b2db4e2b56cdc12550

See more details on using hashes here.

File details

Details for the file ckanext_nhm-7.8.1-py3-none-any.whl.

File metadata

  • Download URL: ckanext_nhm-7.8.1-py3-none-any.whl
  • Upload date:
  • Size: 55.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ckanext_nhm-7.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 40c241d2a804a6d6a68cf895cdf3f4e61571d05734e342769c7034df59a7a7b5
MD5 5856ed5d9b4dddf506ff47af70795eca
BLAKE2b-256 8e54f3da0b2092b166304c1e2019de10d6727a97c1a7fc65fb395e888e44c4b0

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

7.8.1 This release

2 files

7.8.0

2 files

7.7.6

2 files

7.7.5

2 files

7.7.4

2 files

7.7.3

2 files

7.7.2

2 files

7.7.1

2 files

7.7.0

2 files

7.6.2

2 files

7.6.1

2 files

7.6.0

2 files

7.5.1

2 files

7.5.0

2 files

7.4.0

2 files

7.3.0

2 files

7.2.3

2 files

7.2.2

2 files

7.2.1

2 files

7.2.0

2 files

7.1.4

2 files

7.1.3

2 files

7.1.2

2 files

7.1.1

2 files

7.1.0

2 files

7.0.5

2 files

7.0.4

2 files

7.0.3

2 files

7.0.2

2 files

7.0.1

2 files

7.0.0

2 files

6.9.8

2 files

6.9.7

2 files

6.9.6

2 files

6.9.5

2 files

6.9.4

2 files

6.9.3

2 files

6.9.2

2 files

6.9.1

2 files

6.9.0

2 files

6.8.1

2 files

6.8.0

2 files

6.7.1

2 files

6.7.0

2 files

6.6.2

2 files

6.6.1

2 files

6.6.0

2 files

6.5.4

2 files

6.5.3

2 files

6.5.2

2 files

6.5.1

2 files

6.5.0

2 files

6.4.2

2 files

6.4.1

2 files

6.4.0

2 files

6.3.0

2 files

6.2.1

2 files

6.2.0

2 files

6.1.8

2 files

6.1.7

2 files

6.1.6

2 files

6.1.5

2 files

6.1.4

2 files

6.1.3

2 files

6.1.2

2 files

6.1.1

2 files

6.1.0

2 files

6.0.4

2 files

6.0.3

2 files

6.0.2

2 files

6.0.1

2 files

6.0.0

2 files

5.8.2

2 files

5.8.1

2 files

5.8.0

2 files

5.7.0

2 files

5.6.4

2 files

5.6.3

2 files

5.6.2

2 files

5.6.1

2 files

5.6.0

2 files

5.5.1

2 files

5.5.0

2 files

5.4.0

2 files

5.3.0

2 files

5.2.2

2 files

5.2.1

2 files

5.2.0

2 files

5.1.1

2 files

5.1.0

2 files

5.0.3

2 files

5.0.2

2 files

5.0.1

2 files

5.0.0

2 files

4.1.1

2 files

4.1.0

2 files

4.0.5

2 files

4.0.4

2 files

4.0.3

2 files

3.7.1

3 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page