Metadata-Version: 1.0
Name: django-webp
Version: 0.0.2
Summary: django webp
Home-page: http://pypi.python.org/pypi/django-webp/
Author: Andre Farzat
Author-email: andrefarzat@gmail.com
License: LICENSE
Description: django-webp
        ===========
        
        webp middleware for django
        
        [![Build Status](https://travis-ci.org/andrefarzat/django-webp.png?branch=master)](https://travis-ci.org/andrefarzat/django-webp)
        [![Coverage Status](https://coveralls.io/repos/andrefarzat/django-webp/badge.png)](https://coveralls.io/r/andrefarzat/django-webp)
        [![Requirements Status](https://requires.io/github/andrefarzat/django-webp/requirements.png?branch=master)](https://requires.io/github/andrefarzat/django-webp/requirements/?branch=master)
        
        
        ## Installation
        
        First of all, you must install the webp support. Please, check [the official guide](https://developers.google.com/speed/webp/docs/precompiled).
        
        Then, install `django-webp`
        
        ```sh
        pip install django-webp
        ```
        
        add it to `INSTALLED_APPS` configuration
        
        ```python
        INSTALLED_APPS = ('django_webp', ...)
        ```
        
        ## Usage
        
        There are two possible ways: Adding the middleware or by templatetag.
        
        ### Middleware
        
        Add the `django_webp.middleware.` class to `MIDDLEWARE_CLASSES` configuration.
        It is important to let it as the *last* class in the list.
        
        ```python
        MIDDLEWARE_CLASSES = (
            'django.middleware.common.CommonMiddleware',
            'django.contrib.sessions.middleware.SessionMiddleware',
            '...',
            'django_webp.middleware.Webp',
        )
        ```
        
        ### Templatetag
        
        It is necessary to set up the urls to use the templatetag.
        
        ```python
        # urls.py
        
        urlpatterns = patterns(
            url(r'^/webp', 'django_webp.views.webp', name="webp"),
        )
        ```
        
        Load the `webp` module in your template and use the `webp` templatetag to point
        to the image you want to convert.
        
        ```html
        {% load webp %}
        
        {# Use webp as you would use static templatetag #}
        <img src="{% webp 'path/to/your/image.png' %}" alt="image" />
        <!-- produces:
        <img src="/webp/path/to/your/image.png" alt="image" />
        -->
        ```
        
Platform: UNKNOWN
