Provides tailored styling and features for CKAN, according to Avenir Health's requirements for their Spectrum CKAN instance.
For further information please see our other docs:
The following key features are provided by this extension:
- Tailored UI styling, according to the Avenir Health branding.
- Integration with Giftless and CKAN extensions ckanext-blob-storage, ckanext-authz-service and ckanext-versions for revisioning and release management
- Template changes to streamline the UI to Avenir's needs.
- Changes to CKAN auth, to enable all users to be members of one organisation, but only edit their own datasets or the datasets they are collaborators on. The reason for this change is that the ckanext-blob-storage and ckanext-authz-service extensions are tightly coupled with the organisation model.
You can configure the bahaviour of this extension by adding this to the ckan production.ini file:
# The name of organization all newly created users will be added as editors to
# to be able to create datasets in the system. Defaults to 'spectrum'
ckanext.spectrum.default_organization = spectrum
To install ckanext-spectrum:
-
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/fjelltopp/ckanext-spectrum.git cd ckanext-spectrum pip install -e . pip install -r requirements.txt
-
Add
spectrumto 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
To install ckanext-spectrum for development, activate your CKAN virtualenv and do:
git clone https://github.com/fjelltopp/ckanext-spectrum.git
cd ckanext-spectrum
python setup.py develop
pip install -r dev-requirements.txt
To run the tests, do:
pytest --ckan-ini=test.ini