ckanext-geokurstyle

Requirements

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

Installation

To install ckanext-geokurstyle:

1. Activate your CKAN virtual environment, for example:

   . /usr/lib/ckan/default/bin/activate
   

2. Install the ckanext-geokurstyle Python package into your virtual environment:

   pip install ckanext-geokurstyle
   

3. Add geokurstyle to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:

   sudo service apache2 reload
   

Config settings

None at present

Developer installation

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

git clone https://github.com/rue-a/ckanext-geokurstyle.git
cd ckanext-geokurstyle
python setup.py develop
pip install -r dev-requirements.txt

Tests

To run the tests, do:

pytest --ckan-ini=test.ini

To run the tests and produce a coverage report, first make sure you have coverage installed in your virtualenv (pip install coverage) then run:

pytest --ckan-ini=test.ini --cov=ckanext.geokurstyle

Releasing a new version of ckanext-geokurstyle

ckanext-geokurstyle should be available on PyPI as https://pypi.org/project/ckanext-geokurstyle. To publish a new version to PyPI follow these steps:

1. Update the version number in the setup.py file. See PEP 440 for how to choose version numbers.

2. Make sure you have the latest version of necessary packages:

   pip install --upgrade setuptools wheel twine
   

3. Create a source and binary distributions of the new version:

   python setup.py sdist bdist_wheel && twine check dist/*
   

   Fix any errors you get.

4. Upload the source distribution to PyPI:

   twine upload dist/*
   

5. Commit any outstanding changes:

   git commit -a
   

6. 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