ckanext-list
A CKAN extension that adds a list view for resources.
Science Score: 62.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 4 committers (25.0%) from academic institutions -
✓Institutional organization owner
Organization naturalhistorymuseum has institutional domain (www.nhm.ac.uk) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.9%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
A CKAN extension that adds a list view for resources.
Basic Info
Statistics
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 4
- Releases: 17
Topics
Metadata Files
README.md
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
Installing from PyPI
shell
pip install ckanext-list
Installing from source
Clone the repository into the
srcfolder:shell cd $INSTALL_FOLDER/src git clone https://github.com/NaturalHistoryMuseum/ckanext-list.gitActivate the virtual env:
shell . $INSTALL_FOLDER/bin/activateInstall via pip:
shell pip install $INSTALL_FOLDER/src/ckanext-list
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 'list' to the list of plugins in your
$CONFIG_FILE:ini ckan.plugins = ... listInstall
lesscglobally:shell npm install -g "less@~4.1"
Configuration
There are currently no options that can be specified in your .ini config file.
Usage
To use the view in a template:
```html+jinja
{% resource 'ckanext-list/main' %} ```
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:
shell docker compose buildThen 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.
shell docker compose run ckan
Owner
- Name: Natural History Museum
- Login: NaturalHistoryMuseum
- Kind: organization
- Location: London
- Website: https://www.nhm.ac.uk
- Repositories: 171
- Profile: https://github.com/NaturalHistoryMuseum
Citation (CITATION.cff)
cff-version: 1.2.0
title: CKAN List extension
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- name: Natural History Museum
city: London
country: GB
alias: NHM
email: data@nhm.ac.uk
repository-code: 'https://github.com/NaturalHistoryMuseum/ckanext-list'
abstract: A CKAN extension that adds a list view for resources.
keywords:
- ckan
- ckanext
- list
license: GPL-3.0-or-later
version: 2.1.11
GitHub Events
Total
- Release event: 2
- Delete event: 5
- Issue comment event: 2
- Push event: 14
- Pull request event: 15
- Create event: 6
Last Year
- Release event: 2
- Delete event: 5
- Issue comment event: 2
- Push event: 14
- Pull request event: 15
- Create event: 6
Committers
Last synced: almost 3 years ago
All Time
- Total Commits: 71
- Total Committers: 4
- Avg Commits per committer: 17.75
- Development Distribution Score (DDS): 0.408
Top Committers
| Name | Commits | |
|---|---|---|
| Alice Butcher | a****i@g****m | 42 |
| Josh Humphries | j****s@n****k | 15 |
| benscott | b****n@b****k | 7 |
| github-actions[bot] | g****]@u****m | 7 |
Committer Domains (Top 20 + Academic)
Packages
- Total packages: 1
-
Total downloads:
- pypi 197 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 13
- Total maintainers: 1
pypi.org: ckanext-list
A CKAN extension that adds a list view for resources.
- Documentation: https://ckanext-list.readthedocs.io/
- License: GPL-3.0-or-later
-
Latest release: 2.1.11
published 9 months ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- commitizen-tools/commitizen-action master composite
- softprops/action-gh-release v1 composite
- actions/checkout v3 composite
- actions/checkout v3 composite
- actions/setup-python v3 composite
- pypa/gh-action-pypi-publish release/v1 composite
- naturalhistorymuseum/ckantest latest build
- ckan/ckan-solr 2.9
- redis latest
- mkdocs *
- mkdocs-gen-files *
- mkdocs-include-markdown-plugin *
- mkdocs-material *
- mkdocs-section-index *
- mkdocstrings *
- ckantools >=0.3.0
- actions/checkout v3 composite
- connor-baer/action-sync-branch main composite