Extension Spectrum


Extension Basics

Title
Spectrum
Name
ckanext-spectrum
Type
Public extension
Description
Styling and customisation of CKAN for the Avenir Health One Health Tool with tailored UI, auth changes, and integration with Giftless for revisioning.
CKAN versions
Download-Url (zip)
Last commit
a year ago (2024-08-27 22:25:32)
Url to repo
Category
Corporate & Business


Background Infos

Description (long)
Show details

ckanext-spectrum

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: - Spectrum CKAN API Documentation

Key features

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.

Configuration

You can configure the behaviour 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

Installation

To install ckanext-spectrum:

  1. Activate your CKAN virtual environment: . /usr/lib/ckan/default/bin/activate
  2. 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
  3. Add spectrum to the ckan.plugins setting in your CKAN config file.
  4. Restart CKAN.

Developer installation

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

Tests

pytest --ckan-ini=test.ini

License

AGPL-3.0

Version
0.1
Version release date
(not set)
Contact name
Fjelltopp
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Requires ckanext-blob-storage, ckanext-authz-service and ckanext-versions for full functionality.

Plugins to configure (ckan.ini)
spectrum
CKAN Settings (ckan.ini)
# ckanext.spectrum.default_organization = spectrum
DB migration to be executed
(not set)
<< back to Extensions