For example, you might want to mention here which versions of CKAN this extension works with.
To install ckanext-geokurstyle:
Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate
Install the ckanext-geokurstyle Python package into your virtual environment:
pip install ckanext-geokurstyle
Add
geokurstyle
to theckan.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
None at present
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
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
ckanext-geokurstyle should be available on PyPI as https://pypi.org/project/ckanext-geokurstyle. To publish a new version to PyPI follow these steps:
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
Tag the new release of the project on GitHub with the version number from the
setup.py
file. For example if the version number insetup.py
is 0.0.1 then do:git tag 0.0.1 git push --tags