<!--header-start-->
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://data.nhm.ac.uk/images/nhm_logo.svg">
<source media="(prefers-color-scheme: light)" srcset="https://data.nhm.ac.uk/images/nhm_logo_black.svg">
<img alt="The Natural History Museum logo." src="https://data.nhm.ac.uk/images/nhm_logo_black.svg" align="left" width="150px" height="100px" hspace="40">
</picture>
# ckanext-gallery
[](https://github.com/NaturalHistoryMuseum/ckanext-gallery/actions/workflows/tests.yml)
[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-gallery)
[](https://github.com/ckan/ckan)
[](https://www.python.org/)
[](https://ckanext-gallery.readthedocs.io)
_A CKAN extension for a dataset gallery view._
<!--header-end-->
# Overview
<!--overview-start-->
Adds a gallery view for resources on a CKAN instance. Three plugins are included in this extension: the main plugin (`gallery`) and two view plugins for specific image/data types (`gallery_image` and `gallery_iiif`).
Based on [blueimp Gallery](https://blueimp.github.io/Gallery).
<!--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-gallery
```
## Installing from source
1. Clone the repository into the `src` folder:
```shell
cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-gallery.git
```
2. Activate the virtual env:
```shell
. $INSTALL_FOLDER/bin/activate
```
3. Install via pip:
```shell
pip install $INSTALL_FOLDER/src/ckanext-gallery
```
### 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 'gallery' to the list of plugins in your `$CONFIG_FILE`:
```ini
ckan.plugins = ... gallery
```
2. Install `lessc` globally:
```shell
npm install -g "less@~4.1"
```
<!--installation-end-->
# Configuration
<!--configuration-start-->
There's only one option that can be specified in the `.ini` file:
| Name | Description | Default |
|------------------------------------|---------------------------------------|---------|
| `ckanext.gallery.records_per_page` | Number of images to display on a page | 32 |
<!--configuration-end-->
# Usage
<!--usage-start-->
To use as a view, no further setup is needed; the 'Gallery' type should be available for resources
after installing the plugin.
## Interfaces
The `IGalleryImage` interface allows plugins to override settings.
```python
from ckan.plugins import SingletonPlugin, implements
from ckanext.gallery.plugins.interfaces import IGalleryImage
class YourPlugin(SingletonPlugin):
implements(IGalleryImage)
def image_info(self):
'''
Return info for this plugin. If resource type is set,
only datasets of that type will be available.
'''
return {u'title': u'Text',
u'resource_type': [u'csv', u'tsv'],
u'field_type': [u'text']}
def get_images(self, field_value, record, data_dict):
'''
Process images from a single record to return custom metadata.
The field_value depends on the image field you choose.
'''
images = [{
u'href': field_value[u'url'],
u'thumbnail': field_value[u'url'].replace(u'preview', u'thumbnail'),
u'record_id': record[u'_id']
} for img in field_value]
return image
```
## Templates
### Gallery block snippet
```html+jinja
{% snippet 'gallery/snippets/gallery.html', images=g.images, resource_id=res.id %}
```
<!--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-gallery",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "CKAN, data, gallery",
"author": null,
"author_email": "Natural History Museum <data@nhm.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/5e/90/c5099aaaad2d8f095b1bfce00ddc80b198fef1468da6e59ef078d1d68e9c/ckanext_gallery-3.0.3.tar.gz",
"platform": null,
"description": "<!--header-start-->\n<picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://data.nhm.ac.uk/images/nhm_logo.svg\">\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://data.nhm.ac.uk/images/nhm_logo_black.svg\">\n <img alt=\"The Natural History Museum logo.\" src=\"https://data.nhm.ac.uk/images/nhm_logo_black.svg\" align=\"left\" width=\"150px\" height=\"100px\" hspace=\"40\">\n</picture>\n\n# ckanext-gallery\n\n[](https://github.com/NaturalHistoryMuseum/ckanext-gallery/actions/workflows/tests.yml)\n[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-gallery)\n[](https://github.com/ckan/ckan)\n[](https://www.python.org/)\n[](https://ckanext-gallery.readthedocs.io)\n\n_A CKAN extension for a dataset gallery view._\n\n<!--header-end-->\n\n# Overview\n\n<!--overview-start-->\nAdds a gallery view for resources on a CKAN instance. Three plugins are included in this extension: the main plugin (`gallery`) and two view plugins for specific image/data types (`gallery_image` and `gallery_iiif`).\n\nBased on [blueimp Gallery](https://blueimp.github.io/Gallery).\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-gallery\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-gallery.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-gallery\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 'gallery' to the list of plugins in your `$CONFIG_FILE`:\n ```ini\n ckan.plugins = ... gallery\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's only one option that can be specified in the `.ini` file:\n\n| Name | Description | Default |\n|------------------------------------|---------------------------------------|---------|\n| `ckanext.gallery.records_per_page` | Number of images to display on a page | 32 |\n\n<!--configuration-end-->\n\n# Usage\n\n<!--usage-start-->\nTo use as a view, no further setup is needed; the 'Gallery' type should be available for resources\nafter installing the plugin.\n\n## Interfaces\n\nThe `IGalleryImage` interface allows plugins to override settings.\n\n```python\nfrom ckan.plugins import SingletonPlugin, implements\nfrom ckanext.gallery.plugins.interfaces import IGalleryImage\n\nclass YourPlugin(SingletonPlugin):\n implements(IGalleryImage)\n\n\n def image_info(self):\n '''\n Return info for this plugin. If resource type is set,\n only datasets of that type will be available.\n '''\n return {u'title': u'Text',\n u'resource_type': [u'csv', u'tsv'],\n u'field_type': [u'text']}\n\n\n def get_images(self, field_value, record, data_dict):\n '''\n Process images from a single record to return custom metadata.\n The field_value depends on the image field you choose.\n '''\n images = [{\n u'href': field_value[u'url'],\n u'thumbnail': field_value[u'url'].replace(u'preview', u'thumbnail'),\n u'record_id': record[u'_id']\n } for img in field_value]\n return image\n```\n\n## Templates\n\n### Gallery block snippet\n```html+jinja\n{% snippet 'gallery/snippets/gallery.html', images=g.images, resource_id=res.id %}\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 for a dataset gallery view.",
"version": "3.0.3",
"project_urls": {
"changelog": "https://github.com/NaturalHistoryMuseum/ckanext-gallery/blob/main/CHANGELOG.md",
"repository": "https://github.com/NaturalHistoryMuseum/ckanext-gallery"
},
"split_keywords": [
"ckan",
" data",
" gallery"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "abf9cecf4aa11cce008d18948915edbe8e1fe455a90e3005927a960ebbb3f3e9",
"md5": "492f42a1e913d739f440a8e6a284a6eb",
"sha256": "d82acc0aea6d54193090f4c3aae67bd0185a3494c25af67f16d12770be32229b"
},
"downloads": -1,
"filename": "ckanext_gallery-3.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "492f42a1e913d739f440a8e6a284a6eb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 456200,
"upload_time": "2024-11-04T11:40:08",
"upload_time_iso_8601": "2024-11-04T11:40:08.298603Z",
"url": "https://files.pythonhosted.org/packages/ab/f9/cecf4aa11cce008d18948915edbe8e1fe455a90e3005927a960ebbb3f3e9/ckanext_gallery-3.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5e90c5099aaaad2d8f095b1bfce00ddc80b198fef1468da6e59ef078d1d68e9c",
"md5": "9dd06f02ac995f81e10a47ed4c1afa06",
"sha256": "71cdd8d6fa18612fa2dfcf25ad74e8089d708b65df3c9de63c330c7909a5b2e1"
},
"downloads": -1,
"filename": "ckanext_gallery-3.0.3.tar.gz",
"has_sig": false,
"md5_digest": "9dd06f02ac995f81e10a47ed4c1afa06",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 430160,
"upload_time": "2024-11-04T11:40:10",
"upload_time_iso_8601": "2024-11-04T11:40:10.096528Z",
"url": "https://files.pythonhosted.org/packages/5e/90/c5099aaaad2d8f095b1bfce00ddc80b198fef1468da6e59ef078d1d68e9c/ckanext_gallery-3.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 11:40:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NaturalHistoryMuseum",
"github_project": "ckanext-gallery",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ckanext-gallery"
}
JSON
