| Name | ckanext-list JSON |
| Version |
2.1.9
JSON |
| download |
| home_page | None |
| Summary | A CKAN extension that adds a list view for resources. |
| upload_time | 2024-08-20 14:21:53 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | GPL-3.0-or-later |
| keywords |
ckan
data
list
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
<!--header-start-->
<img src="https://data.nhm.ac.uk/images/nhm_logo.svg" align="left" width="150px" height="100px" hspace="40"/>
# ckanext-list
[](https://github.com/NaturalHistoryMuseum/ckanext-list/actions/workflows/main.yml)
[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-list)
[](https://github.com/ckan/ckan)
[](https://www.python.org/)
[](https://ckanext-list.readthedocs.io)
_A CKAN extension that adds a list view for resources._
<!--header-end-->
# Overview
<!--overview-start-->
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](https://github.com/NaturalHistoryMuseum/ckanext-nhm); this [should be fixed](https://github.com/NaturalHistoryMuseum/ckanext-list/issues/9) in future releases (contributions are always welcome).
<!--overview-end-->
# Installation
<!--installation-start-->
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
1. Clone the repository into the `src` folder:
```shell
cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-list.git
```
2. Activate the virtual env:
```shell
. $INSTALL_FOLDER/bin/activate
```
3. Install 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](https://github.com/NaturalHistoryMuseum/ckan) for a version of v2.9 that uses an updated setuptools if this functionality is something you need.
## Post-install setup
1. Add 'list' to the list of plugins in your `$CONFIG_FILE`:
```ini
ckan.plugins = ... list
```
2. Install `lessc` globally:
```shell
npm install -g "less@~4.1"
```
<!--installation-end-->
# Configuration
<!--configuration-start-->
There are currently no options that can be specified in your .ini config file.
<!--configuration-end-->
# Usage
<!--usage-start-->
To use the view in a template:
```html+jinja
<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' %}
```
<!--usage-end-->
# Testing
<!--testing-start-->
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:
1. Build the required images:
```shell
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.
```shell
docker compose run ckan
```
<!--testing-end-->
Raw data
{
"_id": null,
"home_page": null,
"name": "ckanext-list",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "CKAN, data, list",
"author": null,
"author_email": "Natural History Museum <data@nhm.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/27/b9/277ead9d77c7908cd14d10e5d8e7e8dff553c105638a371f03299855eaf3/ckanext_list-2.1.9.tar.gz",
"platform": null,
"description": "<!--header-start-->\n<img src=\"https://data.nhm.ac.uk/images/nhm_logo.svg\" align=\"left\" width=\"150px\" height=\"100px\" hspace=\"40\"/>\n\n# ckanext-list\n\n[](https://github.com/NaturalHistoryMuseum/ckanext-list/actions/workflows/main.yml)\n[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-list)\n[](https://github.com/ckan/ckan)\n[](https://www.python.org/)\n[](https://ckanext-list.readthedocs.io)\n\n_A CKAN extension that adds a list view for resources._\n\n<!--header-end-->\n\n# Overview\n\n<!--overview-start-->\nThis 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.\n\n**NB**: This extension currently only works with the Natural History Museum's theme extension [ckanext-nhm](https://github.com/NaturalHistoryMuseum/ckanext-nhm); this [should be fixed](https://github.com/NaturalHistoryMuseum/ckanext-list/issues/9) in future releases (contributions are always welcome).\n\n<!--overview-end-->\n\n# Installation\n\n<!--installation-start-->\nPath variables used below:\n- `$INSTALL_FOLDER` (i.e. where CKAN is installed), e.g. `/usr/lib/ckan/default`\n- `$CONFIG_FILE`, e.g. `/etc/ckan/default/development.ini`\n\n## Installing from PyPI\n\n```shell\npip install ckanext-list\n```\n\n## Installing from source\n\n1. Clone the repository into the `src` folder:\n ```shell\n cd $INSTALL_FOLDER/src\n git clone https://github.com/NaturalHistoryMuseum/ckanext-list.git\n ```\n\n2. Activate the virtual env:\n ```shell\n . $INSTALL_FOLDER/bin/activate\n ```\n\n3. Install via pip:\n ```shell\n pip install $INSTALL_FOLDER/src/ckanext-list\n ```\n\n### Installing in editable mode\n\nInstalling 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](https://github.com/NaturalHistoryMuseum/ckan) for a version of v2.9 that uses an updated setuptools if this functionality is something you need.\n\n## Post-install setup\n\n1. Add 'list' to the list of plugins in your `$CONFIG_FILE`:\n ```ini\n ckan.plugins = ... list\n ```\n\n2. Install `lessc` globally:\n ```shell\n npm install -g \"less@~4.1\"\n ```\n\n<!--installation-end-->\n\n# Configuration\n\n<!--configuration-start-->\nThere are currently no options that can be specified in your .ini config file.\n\n<!--configuration-end-->\n\n# Usage\n\n<!--usage-start-->\nTo use the view in a template:\n\n```html+jinja\n<div data-module=\"list\"\n data-module-resource = \"{{ h.dump_json(resource_json) }}\"\n data-module-resource-view = \"{{ h.dump_json(resource_view_json) }}\">\n</div>\n\n{% resource 'ckanext-list/main' %}\n```\n\n<!--usage-end-->\n\n# Testing\n\n<!--testing-start-->\nThere 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.\n\nTo run the tests against ckan 2.9.x on Python3:\n\n1. Build the required images:\n ```shell\n docker compose build\n ```\n\n2. Then run the tests.\n The root of the repository is mounted into the ckan container as a volume by the Docker compose\n configuration, so you should only need to rebuild the ckan image if you change the extension's\n dependencies.\n ```shell\n docker compose run ckan\n ```\n\n<!--testing-end-->\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "A CKAN extension that adds a list view for resources.",
"version": "2.1.9",
"project_urls": {
"changelog": "https://github.com/NaturalHistoryMuseum/ckanext-list/blob/main/CHANGELOG.md",
"repository": "https://github.com/NaturalHistoryMuseum/ckanext-list"
},
"split_keywords": [
"ckan",
" data",
" list"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "af98ee8f28440b84b9337777d701d0afe83dc32c8f92e5c93971a3dc694eb593",
"md5": "dd2a0b272482c035aa5067652af1cd6e",
"sha256": "aeeacb7ca41580c179751bfc510ec9429dd1df1f4fac61ed6db3212ab67927a4"
},
"downloads": -1,
"filename": "ckanext_list-2.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dd2a0b272482c035aa5067652af1cd6e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 26848,
"upload_time": "2024-08-20T14:21:52",
"upload_time_iso_8601": "2024-08-20T14:21:52.516973Z",
"url": "https://files.pythonhosted.org/packages/af/98/ee8f28440b84b9337777d701d0afe83dc32c8f92e5c93971a3dc694eb593/ckanext_list-2.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "27b9277ead9d77c7908cd14d10e5d8e7e8dff553c105638a371f03299855eaf3",
"md5": "06d1e65f3bb17f3c050bf5fe55cc1bc1",
"sha256": "84d1daf3b7368117d5209b54787511d4a90a470589f8c0a6eb73fdb89bf865f2"
},
"downloads": -1,
"filename": "ckanext_list-2.1.9.tar.gz",
"has_sig": false,
"md5_digest": "06d1e65f3bb17f3c050bf5fe55cc1bc1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 26478,
"upload_time": "2024-08-20T14:21:53",
"upload_time_iso_8601": "2024-08-20T14:21:53.506379Z",
"url": "https://files.pythonhosted.org/packages/27/b9/277ead9d77c7908cd14d10e5d8e7e8dff553c105638a371f03299855eaf3/ckanext_list-2.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-20 14:21:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NaturalHistoryMuseum",
"github_project": "ckanext-list",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ckanext-list"
}
