Extension Thumbnail Generator


Extension Basics

Title
Thumbnail Generator
Name
ckanext-thumbnailer
Type
Public extension
Description
Automatic thumbnail generation for resource files
CKAN versions

~2.9, ~2.10, ~2.11

Show details
Download-Url (zip)
Download-Url commit date
2024-10-17
Url to repo
Category
Visualization & Analytics


Background Infos

Description (long)
Show details

Extension that automatically generates thumbnails for various resource file formats using the preview-generator library. Requires ckanext-files extension and can automatically create thumbnails when resources are created or updated for specified formats. Supports downloading remote linked resources for thumbnail generation if their size is under a configurable limit. The extension leverages the preview-generator Python library which may require additional system packages for different file formats - consult preview-generator documentation for specific requirements. Compatible with CKAN 2.9 and master, Python 3.8+ supported up to Python 3.14. Optional ‘all’ extras installs preview-generator with support for all formats. Thumbnails are generated using ckanext-files storage infrastructure.

Version
0.1.4.post1
Version release date
2024-10-17
Contact name
DataShades
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Installation: pip install ckanext-thumbnailer. May fail due to missing system packages - check preview-generator documentation (https://pypi.org/project/preview-generator/) for required system dependencies. Add ‘files’ and ‘thumbnailer’ to ckan.plugins (in that order): ckan.plugins = … thumbnailer files. Configuration: ckanext.thumbnailer.max_remote_size = 0 (optional, default: 0 - if greater than 0, download linked resources for thumbnail generation if size is under this limit in bytes). ckanext.thumbnailer.auto_formats = pdf png (optional, default: None - list of formats that will automatically get thumbnails when resource is created/updated, space-separated). Dependencies: ckanext-files >= 1.0.0a0, preview-generator, ckanext-toolbelt, typing_extensions. Optional Extras: Install with [all] for full format support: pip install ‘ckanext-thumbnailer[all]’ (installs preview-generator[all]). System Requirements: Various system packages may be needed depending on formats (ImageMagick, LibreOffice, FFmpeg, etc.) - see preview-generator docs. Python 3.8-3.14 supported. Compatible with CKAN 2.9 and master.

Plugins to configure (ckan.ini)
thumbnailer
CKAN Settings (ckan.ini)
# ckanext.thumbnailer.max_remote_size = 0 # ckanext.thumbnailer.auto_formats = pdf png
DB migration to be executed
(not set)
<< back to Extensions