Compatibility with core CKAN versions:
| CKAN version | Compatible? |
|---|---|
| 2.8 and earlier | no |
| 2.9 | yes |
To install ckanext-resource-visibility:
-
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//ckanext-resource-visibility.git cd ckanext-resource-visibility pip install -e . pip install -r requirements.txt
-
Add
resource-visibilityto theckan.pluginssetting 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
# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.resource_visibility.some_setting = some_default_value
To install ckanext-resource-visibility for development, activate your CKAN virtualenv and do:
git clone https://github.com//ckanext-resource-visibility.git
cd ckanext-resource-visibility
python setup.py develop
pip install -r dev-requirements.txt
To run the tests, do:
pytest --ckan-ini=test.ini
If ckanext-resource-visibility should be available on PyPI you can follow these steps to publish a new version:
-
Update the version number in the
setup.pyfile. 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.pyfile. For example if the version number insetup.pyis 0.0.1 then do:git tag 0.0.1 git push --tags