Generates thumbnails for datasets.
Project description
This CKAN extension adds support for generation and display of thumbnail images. The helper function thumbnail_url can be called from a template, as in this example:
{% block thumbnail %} {% set thumbnail = h.thumbnail_url(package.id) %} {% if thumbnail %} <a href="{{ h.url_for(controller='package', action='read', id=package.name) }}"> <img class="dataset-list-thumbnail" src="{{ thumbnail }}"> </a> {% endif %} {% endblock %}
If a resource exists with the name thumbnail.png, this will be used.
If no resource exists with this name and the logged-in user has sufficient access, the thumbnail will be generated from the first matching JPEG or PNG resource.
If no thumbnail exists at this point, a placeholder image will be used.
Requirements
CKAN 2.5.2
Pillow 3.2.0 (with PngImagePlugin and JpegImagePlugin)
Installation
To install ckanext-datasetthumbnail:
Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate
Install the ckanext-datasetthumbnail Python package into your virtual environment:
pip install ckanext-datasetthumbnail
Add datasetthumbnail to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini).
Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu:
sudo service apache2 reload
Config Settings
# Show thumbnails # (optional, default: False). ckan.datasetthumbnail.show_thumbnail = True # Autogenerate thumbnails # (optional, default: False). ckan.datasetthumbnail.auto_generate = True # Generated thumbnail width # (optional, default: 140). ckan.datasetthumbnail.thumbnail_width = 140 # Generated thumbnail height # (optional, default: int(width * 1.415) ckan.datasetthumbnail.thumbnail_height = 140
Development Installation
To install ckanext-datasetthumbnail for development, activate your CKAN virtualenv and do:
git clone https://github.com/aptivate/ckanext-datasetthumbnail.git cd ckanext-datasetthumbnail python setup.py develop pip install -r dev-requirements.txt
Running the Tests
To run the tests, do:
nosetests --nologcapture --with-pylons=test.ini
To run the tests and produce a coverage report, first make sure you have coverage installed in your virtualenv (pip install coverage) then run:
nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.datasetthumbnail --cover-inclusive --cover-erase --cover-tests
Registering ckanext-datasetthumbnail on PyPI
ckanext-datasetthumbnail should be availabe on PyPI as https://pypi.python.org/pypi/ckanext-datasetthumbnail. If that link doesn’t work, then you can register the project on PyPI for the first time by following these steps:
Create a source distribution of the project:
python setup.py sdist
Register the project:
python setup.py register
Upload the source distribution to PyPI:
python setup.py sdist upload
Tag the first release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py is 0.0.1 then do:
git tag 0.0.1 git push --tags
Releasing a New Version of ckanext-datasetthumbnail
ckanext-datasetthumbnail is availabe on PyPI as https://pypi.python.org/pypi/ckanext-datasetthumbnail. To publish a new version to PyPI follow these steps:
Update the version number in the setup.py file. See PEP 440 for how to choose version numbers.
Create a source distribution of the new version:
python setup.py sdist
Upload the source distribution to PyPI:
python setup.py sdist upload
Tag the new release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py is 0.0.2 then do:
git tag 0.0.2 git push --tags
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
Hashes for ckanext-datasetthumbnail-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdeb653ee3f6e3544a886170b274eab8027c4edf2ef9d6676c1b46340e982c8d |
|
MD5 | 366787029c7e4d49fe9b185cc1945a3f |
|
BLAKE2b-256 | aea49c626d8b363beca3aff996269a2d58eed35641bf0db456c5b8463292d808 |