A CKAN extension that adds a view for displaying generic/arbitrary URLs.
Project description
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
- 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 the requirements from requirements.txt:
cd $INSTALL_FOLDER/src/ckanext-webview
pip install -r requirements.txt
- Run setup.py:
cd $INSTALL_FOLDER/src/ckanext-webview
python setup.py develop
- 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:
- 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
The ckan image uses the Dockerfile in the docker/
folder which is based on `openknowledge/ckan-dev:2.9'.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for ckanext_webview-1.0.0-py3.10.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8f9415c1ff223a13bd64c66340dc187c436367b7b22e07f6a8163c0f5a261f9 |
|
MD5 | 4a6456e6ecb21273249381eb731db8ef |
|
BLAKE2b-256 | e96da7c0fa68ab6a00033584007702ae29d58916671b104dbcfdd966cd6ea4f4 |
Hashes for ckanext_webview-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6726b07bb4433d6830ad1fa499fea561f067cccea7b429c88ca9eeeeb9aa9228 |
|
MD5 | 3974ac087e7e196b252fbe53836ce2d3 |
|
BLAKE2b-256 | 503535254ae7eaba5c016db6b31cf092414ca206d06464dc5e509fdea64e418b |