ckanext-webview

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

Installing from PyPI

pip install ckanext-webview

Installing from source

• Clone the repository into the src folder:

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

• Activate the virtual env:

  . $INSTALL_FOLDER/bin/activate
  

• Install via pip:

  pip install $INSTALL_FOLDER/src/ckanext-webview
  

Installing in editable mode

Installing from a pyproject.toml in editable mode (i.e. pip install -e) requires setuptools>=64; however, CKAN 2.9 requires setuptools==44.1.0. See our CKAN fork for a version of v2.9 that uses an updated setuptools if this functionality is something you need.

Post-install setup

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

  ckan.plugins = ... webview
  

• Install lessc globally:

  npm install -g "less@~4.1"
  

Configuration

There are currently no options that can be specified in your .ini config file.

Usage

After enabling this extension in the list of plugins, the Web view should become available for resources. The URL can be overridden when creating the view.

Testing

There is a Docker compose configuration available in this repository to make it easier to run tests. The ckan image uses the Dockerfile in the docker/ folder.

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

• Build the required images:

  docker compose build
  

• 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