[![Tests](https://github.com/Liliʻuokalani Trust/ckanext-nhdp/workflows/Tests/badge.svg?branch=main)](https://github.com/Liliʻuokalani Trust/ckanext-nhdp/actions)

ckanext-nhdp

TODO: Put a description of your extension here: What does it do? What features does it have? Consider including some screenshots or embedding a video!

Requirements

TODO: For example, you might want to mention here which versions of CKAN this extension works with.

If your extension works across different versions you can add the following table:

Compatibility with core CKAN versions:

CKAN version	Compatible?
2.6 and earlier	not tested
2.7	not tested
2.8	not tested
2.9	not tested

Suggested values:

"yes"
"not tested" - I can't think of a reason why it wouldn't work
"not yet" - there is an intention to get it working
"no"

Installation

TODO: Add any additional install steps to the list below. For example installing any non-Python dependencies or adding any required config settings.

To install ckanext-nhdp:

Activate your CKAN virtual environment, for example:

. /usr/lib/ckan/default/bin/activate
Clone the source and install it on the virtualenv

git clone https://github.com/Liliʻuokalani Trust/ckanext-nhdp.git cd ckanext-nhdp pip install -e . pip install -r requirements.txt
Add nhdp to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).
Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:

sudo service apache2 reload

Config settings

None at present

TODO: Document any optional config settings here. For example:

# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.nhdp.some_setting = some_default_value

Developer installation

To install ckanext-nhdp for development, activate your CKAN virtualenv and do:

git clone https://github.com/Liliʻuokalani Trust/ckanext-nhdp.git
cd ckanext-nhdp
python setup.py develop
pip install -r dev-requirements.txt

Tests

To run the tests, do:

pytest --ckan-ini=test.ini

Releasing a new version of ckanext-nhdp

If ckanext-nhdp should be available on PyPI you can follow these steps to publish a new version:

Update the version number in the setup.py file. See PEP 440 for how to choose version numbers.
Make sure you have the latest version of necessary packages:

pip install --upgrade setuptools wheel twine
Create a source and binary distributions of the new version:
```
python setup.py sdist bdist_wheel && twine check dist/*
```
Fix any errors you get.
Upload the source distribution to PyPI:
```
twine upload dist/*
```
Commit any outstanding changes:
```
git commit -a
git push
```
Tag the new release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py is 0.0.1 then do:
```
git tag 0.0.1
git push --tags
```

License

AGPL

turbomanson/ckanext-nhdp