Returns a webp image instead of jpg, gif or png to browsers
Project description
Speeds up static file load times by generating a webp image to load to a webpage instead of a jpg, gif or png
Usage
Load the webp module in your template and use the webp templatetag to point to the image you want to convert.
{% load webp %}
{# Use webp as you would use static templatetag #}
<img src="{% webp 'path/to/your/image.png' %}" alt="image" />
<!--
If the browser has support, generates:
<img src="/static/WEBP_CACHE/path/to/your/image.webp" alt="image" />
else, generates:
<img src="/static/path/to/your/image.png" alt="image" />
-->
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:
apt-get install libwebp-dev
Please, check the official guide for the other systems.
Then, install django-webp.
pip install django-webp
add it to INSTALLED_APPS configuration
INSTALLED_APPS = (
'django.contrib.staticfiles',
'django_webp',
'...',
)
add the django_webp context processor
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.
USING_WHITENOISE
Set to True when whitenoise is used as middleware, defaults to False if not. Used to determine the directory to store the WEBP_CACHE.
Possible problems
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.
Cleaning the cache
You can clean the cache running:
python manage.py clean_webp_images
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
Built Distribution
Hashes for django_webp-2.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d33e1c461689579ffbb00c837d45b00c0ca02f1a85477e4af08a94a1bd117468 |
|
MD5 | 23f79a99e95f63a0a5de6115802c69b2 |
|
BLAKE2b-256 | 88b28d230546481cab1687a50b75c67f54ff52dca287dc99e53a1476e364ca16 |