https://github.com/andrefarzat/django-webp

Speeds up static file load times by generating a webp image to load to a webpage instead of a jpg, gif or png
https://github.com/andrefarzat/django-webp

Last synced: about 2 months ago
JSON representation

Speeds up static file load times by generating a webp image to load to a webpage instead of a jpg, gif or png

• Host: GitHub
• URL: https://github.com/andrefarzat/django-webp
• Owner: django-master
• License: mit
• Created: 2014-04-21T23:14:30.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-12-08T08:25:48.000Z (9 months ago)
• Last Synced: 2024-05-19T07:38:16.261Z (4 months ago)
• Language: Python
• Homepage:
• Size: 260 KB
• Stars: 36
• Watchers: 3
• Forks: 14
• Open Issues: 10
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• starred-awesome - django-webp - Returns a webp image instead of jpg, gif or png to browsers which have support (Python)

README

        
django-webp

===========

Speeds up static file load times by generating a webp image to load to a webpage instead of a jpg, gif or png

|Build Status| |Coverage Status|

Usage

-----

Load the ``webp`` module in your template and use the ``webp``

templatetag to point to the image you want to convert.

.. code:: html

    {% load webp %}

    {# Use webp as you would use static templatetag #}

    

    

Installation

------------

First, if you are using a version of Pillow <= 9.3.0, you must install  webp support since earlier versions of Pillow do not 

have webp support built-in. In ubuntu, you can install via apt-get:

.. code:: sh

    apt-get install libwebp-dev

Please, check `the official guide`_ for the other systems.

Then, install ``django-webp``.

.. code:: sh

    pip install django-webp

add it to ``INSTALLED_APPS`` configuration

.. code:: python

    INSTALLED_APPS = (

        'django.contrib.staticfiles',

        'django_webp',

        '...',

    )

    

edit your installation of Whitenoise to use our slightly modded version of it

.. code:: python

    MIDDLEWARE = [

        'django.middleware.security.SecurityMiddleware',

        'django_webp.middleware.ModdedWhiteNoiseMiddleware',

        '...',

    ]

add the django\_webp context processor

.. code:: python

    TEMPLATES = [

        {

            '...'

            'OPTIONS': {

                'context_processors': [

                    '...',

                    'django_webp.context_processors.webp',

                ],

            },

        },

    ]

Settings

--------

The following Django-level settings affect the behavior of the library

- ``WEBP_CHECK_URLS``

  When set to ``True``, urls that link to externally stored images (i.e. images hosted by another site) are checked to confirm if they are valid image links.

  Ideally, this should temporarily be set to ``True`` whenever the ``WEBP_CACHE`` has been cleaned or if there has been substantial changes to your project's template files.

  This defaults to ``False``.

  

Possible Issues

-----------------

- ``django-webp`` uses ``Pillow`` to convert the images. If you’ve installed the ``libwebp-dev`` after already installed ``Pillow``, it’s necessary to uninstall and install it back because it needs to be compiled with it.

- This package was built specifically for production environments that use Whitenoise for serving static files so there currently isn't support for serving files via dedicated servers or through cloud services

Cleaning the cache

------------------

You can clean the cache running:

.. code:: sh

    python manage.py clean_webp_images

.. _the official guide: https://developers.google.com/speed/webp/docs/precompiled

.. |Build Status| image:: https://github.com/andrefarzat/django-webp/actions/workflows/django.yml/badge.svg?branch=master

   :target: https://github.com/andrefarzat/django-webp/actions/workflows/django.yml

.. |Coverage Status| image:: https://coveralls.io/repos/github/andrefarzat/django-webp/badge.svg?branch=master

   :target: https://coveralls.io/github/andrefarzat/django-webp?branch=master