Metadata-Version: 1.1
Name: django-ultimatethumb
Version: 0.4.0
Summary: Generate thumbnails of anything.
Home-page: http://github.com/moccu/django-ultimatethumb/
Author: Moccu GmbH & Co. KG
Author-email: info@moccu.com
License: BSD
Description: django-ultimatethumb
        ====================
        
        .. image:: https://badge.fury.io/py/django-ultimatethumb.png
            :target: http://badge.fury.io/py/django-ultimatethumb
        
        .. image:: https://travis-ci.org/moccu/django-ultimatethumb.svg?branch=master
            :target: https://travis-ci.org/moccu/django-ultimatethumb
        
        .. image:: https://coveralls.io/repos/moccu/django-ultimatethumb/badge.svg
            :target: https://coveralls.io/r/moccu/django-ultimatethumb
        
        .. image:: https://readthedocs.org/projects/django-ultimatethumb/badge/?version=latest
            :target: https://readthedocs.org/projects/django-ultimatethumb/?badge=latest
        
        
        What is django-ultimatethumb
        ----------------------------
        
        `django-ultimatethumb` is another Django library for generating thumbnails but
        has some advantages:
        
        * Thumbnails are not generated when the templatetag is called. Instead, images
          are generated on demand when they are requested by the browser. This can
          lead to a major speedup of your page response times.
        * Thumbnails can be generated from static files too (for example to downscale
          retina-optimized images and therefore reducing traffic).
        * Generate multiple thumbnail sizes at once for use in `picture` html tags with
          multiple sources (e.g. with media queries).
        
        
        .. hint::
        
            The documentation is still work in progress but the library is already in use
            for a while now. We working hard on providing a better documentation!
        
        
        Quick start
        -----------
        
        To install `django-ultimatethumb` just use your preferred Python package installer::
        
            $ pip install django-ultimatethumb
        
        Add some stuff  to your Django settings
        
        .. code-block:: python
        
            INSTALLED_APPS = (
                # some other apps
                'ultimatethumb',
            )
        
            # This is the path where the generated thumbnail files are cached.
            ULTIMATETHUMB_ROOT = '/filesystem/path/to/thumbnails/'
            # This is the base url for your thumbnails
            ULTIMATETHUMB_URL = '/thumbnails/'
        
        Next, add the `django-ultimatethumb` urls to your ``urls.py``
        
        .. code-block:: python
        
            urlpatterns += patterns(
                '',
                url(
                    r'^{0}/'.format(settings.ULTIMATETHUMB_URL.strip('/')),
                    include('ultimatethumb.urls')
                ),
        
        .. hint::
        
            You can use the ``ULTIMATETHUMB_URL`` setting in your ``urls.py`` to make
            sure that the urls are in sync.
        
        To use `django-ultimatethumb` in your templates, just load the templatetags and
        call the ``ultimatethumb`` tag with proper parameters:
        
        .. code-block:: html
        
            {% load ultimatethumb_tags %}
            {% ultimatethumb 'mythumb' mymodel.imagefield.name sizes='400x0,200x0' %}
            <picture>
            {% for source in mythumb %}
                <source
                    srcset="{{ source.url_2x }} 2x, {{ source.url }} 1x"
                    {% if not forloop.last %}media="(max-width: {{ source.size.width }}px)"{% endif %}
                />
                {% if forloop.last %}<img src="{{ source.url }}" />{% endif %}
            {% endfor %}
            </picture>
        
        This gives you a full-featured picture tag including multiple sources with
        media queries for different browser sizes and also provides retina images.
        
        You can also use `django-ultimatethumb` in a much simpler way:
        
        .. code-block:: html
        
            {% load ultimatethumb_tags %}
            {% ultimatethumb 'mythumb' mymodel.imagefield.name sizes='400x0' %}
            <img src="{{ mythumb.0.url }}" />
        
        To resize static images, just prefix the path with ``static:``, for example:
        
        .. code-block:: html
        
            {% load ultimatethumb_tags %}
            {% ultimatethumb 'mythumb' 'static:img/logo.jpg' sizes='400x0' %}
            <img src="{{ mythumb.0.url }}" />
        
        There are many other options/parameters to pass to the templatetag. Please refer
        to the codebase until the documentation is more complete.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Framework :: Django
