ckanext-observability
Observability plugin
Getting Started
Install the extension on your virtualenv:
(pyenv) $ pip install -e git+https://github.com/OpenGov-OpenData/ckanext-observability.git#egg=ckanext-observability
Install the extension requirements:
(pyenv) $ pip install -r ckanext-observability/requirements.txt
Installation
To install ckanext-observablity:
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/OpenGov-OpenData/ckanext-observability.git
cd ckanext-observablity
pip install -e .
pip install -r requirements.txt
Add observablity 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.observablity.some_setting = some_default_value
Developer installation
To install ckanext-observablity for development, activate your CKAN virtualenv and
do:
git clone https://github.com/OpenGov-OpenData/ckanext-observability.git
cd ckanext-observablity
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-observablity
If ckanext-observablity 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: