Metadata-Version: 2.0
Name: djangocms-unitegallery
Version: 0.1.0
Summary: unitegallery grid Plugin for django CMS
Home-page: https://github.com/izimobil/djangocms-unitegallery
Author: David Jean Louis
Author-email: izimobil@gmail.com
License: LICENSE.txt
Platform: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.7
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Requires-Dist: django (>=1.7)
Requires-Dist: django-cms (>=3.0)
Requires-Dist: sorl-thumbnail (>=12.0)

djangocms-unitegallery
======================

.. image:: https://travis-ci.org/izimobil/djangocms-unitegallery.svg?branch=master
    :target: https://travis-ci.org/izimobil/djangocms-unitegallery

.. image:: https://img.shields.io/pypi/l/djangocms-unitegallery.svg

.. image:: https://img.shields.io/pypi/pyversions/djangocms-unitegallery.svg

.. image:: https://img.shields.io/badge/django-1.7%20or%20newer-green.svg

.. image:: https://img.shields.io/badge/djangocms-3%20or%20newer-green.svg

.. image:: https://img.shields.io/pypi/dm/djangocms-unitegallery.svg


A gallery plugin for django CMS that uses the excellent
`Unite Gallery <http://unitegallery.net>`_ jQuery plugin.


Installation
------------

This plugin requires `django CMS` 3.0 or higher and `sorl-thumbnail`
12.0 or higher to work.

* Run ``pip install djangocms-unitegallery``
* Add ``'sorl.thumbnail'`` and ``'djangocms_unitegallery'`` to your ``INSTALLED_APPS``
* Run ``python manage.py migrate``

.. note::
    It's up to you to include jQuery js file in your templates, just make
    sure you include it **before** the sekizai ``{% render_block js %}``.


Configuration
-------------

By default djangocms-unitegallery generates thumbnails for better perfomance.
The default behavior is to generate thumbnails by resizing and cropping images
in a square of 250x250 px.

You can disable completely the thumbnail generation and leave Unite Gallery
handles images and preview, or you can change the default size of generated
thumbnails and/or wether the image ratio should be preserved or not::

    DJANGOCMS_UNITEGALLERY_CONFIG = {
        'THUMBNAIL_ENABLED': true,
        'THUMBNAIL_MAX_WIDTH': 250,
        'THUMBNAIL_MAX_HEIGHT': 250,
        'THUMBNAIL_PRESERVE_RATIO': False, 
    }

If you set ``THUMBNAIL_PRESERVE_RATIO`` to ``False``, thumbnails will be
cropped to match the configured width and height.
If you set ``THUMBNAIL_PRESERVE_RATIO`` to ``True``, thumbnails
will just be resized to match the configured max width (if image is landscape)
or height (if image is portrait).

.. note::
    Due to Unite Gallery behavior, and depending on configured options, you
    are not guaranteed to have the thumbnail size you configured in settings.


