This is a template for NHM CKAN extensions.

Requirements

• cookiecutter
• pre-commit
• commitizen

Other relevant tools:

• ruff (linter and formatter)
• docformatter (docstring formatter)

Usage

To create a new extension using this template:

1. git clone this repo somewhere sensible (e.g. ~/.biscuits)
2. cd to the directory you'd like to make the new extension in (e.g. /path/to/ckan/src/)
3. cookiecutter ~/.biscuits/cookiecutter-ckanext

You might also be able to use cookiecutter gh:NaturalHistoryMuseum/cookiecutter-ckanext (without having to clone anything).

Once created, init the git repo and install the pre-commit hooks:

git init
pre-commit install

To make a commit:

git add .  # or whatever
cz c

The pre-commit hooks will be run automatically. If they fail you can use cz c --retry.

Running pre-commit manually

To run all the pre-commit hooks manually on all files:

pre-commit run --all-files

To run a single hook manually (e.g. ruff formatter) on all files:

pre-commit run ruff-format --all-files

To run hooks on only modified files, omit the --all-files.

Other steps

Don't forget to add the secrets: PERSONAL_ACCESS_TOKEN (create one here) and COVERALLS_REPO_TOKEN (get it from the individual coveralls repo page - here's all the NHM repos).