A CKAN extension that adds a list view for resources.
Project description
ckanext-list
A CKAN extension that adds a list view for resources.
Overview
This extension adds a list view for resources on a CKAN instance. Records are listed as brief summaries, with a configurable set of fields shown for each.
NB: This extension currently only works with the Natural History Museum's theme extension ckanext-nhm; this should be fixed in future releases (contributions are always welcome).
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-list.git
- Activate the virtual env:
. $INSTALL_FOLDER/bin/activate
- Install the requirements from requirements.txt:
cd $INSTALL_FOLDER/src/ckanext-list
pip install -r requirements.txt
- Run setup.py:
cd $INSTALL_FOLDER/src/ckanext-list
python setup.py develop
- Add 'list' to the list of plugins in your
$CONFIG_FILE
:
ckan.plugins = ... list
Configuration
There are currently no options that can be specified in your .ini config file.
Usage
To use the view in a template:
<div data-module="list"
data-module-resource = "{{ h.dump_json(resource_json) }}"
data-module-resource-view = "{{ h.dump_json(resource_view_json) }}">
</div>
{% resource 'ckanext-list/main' %}
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_list-2.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a713781a75d84dc1a8ec55eeeef83638c34615e1caba27ba31870ec2aaeaf98 |
|
MD5 | dac62a9c2cb2743fb6bb7c4607d5bcc7 |
|
BLAKE2b-256 | bd58bc883ef63d0732ca4c630af85e0754e76ef9bd30b3476479862486b2f40a |