ckanext-webview 1.0.0

A CKAN extension that adds a view for displaying generic/arbitrary URLs.

ckanext-webview

A CKAN extension that adds a view for displaying generic/arbitrary URLs.

Overview

This extension allows maintainers to add a simple static message to the top of every page by setting a single configuration option. For example, it can be used to notify users of planned downtime, unexpected issues with the site, or new features.

Installation

Path variables used below:

• $INSTALL_FOLDER (i.e. where CKAN is installed), e.g. /usr/lib/ckan/default
• $CONFIG_FILE, e.g. /etc/ckan/default/development.ini

1. Clone the repository into the src folder:

cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-webview.git

2. Activate the virtual env:

. $INSTALL_FOLDER/bin/activate

3. Install the requirements from requirements.txt:

cd $INSTALL_FOLDER/src/ckanext-webview
pip install -r requirements.txt

4. Run setup.py:

cd $INSTALL_FOLDER/src/ckanext-webview
python setup.py develop

5. Add 'webview' to the list of plugins in your $CONFIG_FILE:

ckan.plugins = ... webview

Testing

Test coverage is currently extremely limited.

To run the tests in this extension, there is a Docker compose configuration available in this repository to make it easy.

To run the tests against ckan 2.9.x on Python3:

1. Build the required images

docker-compose build

2. Then run the tests. The root of the repository is mounted into the ckan container as a volume by the Docker compose configuration, so you should only need to rebuild the ckan image if you change the extension's dependencies.

docker-compose run ckan

The ckan image uses the Dockerfile in the docker/ folder which is based on `openknowledge/ckan-dev:2.9'.