django-img-optimizer 0.0__py3-none-any.whl

django_img_optimizer/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class ImageOptimizerConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'django_img_optimizer'

django_img_optimizer/management/commands/optimize_images.py

@@ -0,0 +1,23 @@
+# https://docs.djangoproject.com/en/5.0/howto/custom-management-commands/
+
+from django.core.management.base import BaseCommand, CommandError
+from PIL import Image
+from glob import iglob
+import os
+from django_img_optimizer.utils import delete_optimized_images, optimize_images
+
+class Command(BaseCommand):
+    help = 'Optimizes images by converting them to WebP and AVIF'
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+                "--delete",
+                action="store_true",
+                help="Delete all optimized images from static folder",
+            )
+
+    def handle(self, *args, **options):
+        if options["delete"]:
+            delete_optimized_images()
+        else:
+            optimize_images()

django_img_optimizer/templatetags/image_optimizer.py

@@ -0,0 +1,50 @@
+from django import template
+from django.templatetags.static import static
+from django.utils.safestring  import mark_safe
+from django.contrib.staticfiles.finders import find
+import re
+
+register = template.Library()
+
+@register.simple_tag()
+def optimized_image(*args):
+    """
+    Returns:
+        str: A html picture tag with an optimized webp image if it exists, or just the original image if no optimized image is found.
+
+    Args:
+        *args: Variable number of arguments representing the attributes for the image tag.
+    """
+    attributes = ' '.join(args)
+
+
+    # Get src attribute value
+    match_src = re.search(r'src="([^"]+)"', attributes)
+    # print(match_src)
+    # print('************')
+    relative_image_path = match_src.group(1) if match_src.group(1) is not None else "src could not be found"
+
+    # Get django static path
+    image_static_src = static(relative_image_path)
+
+    # Replace src in attributes with django static src
+    attributes_output = re.sub(r'(src=")([^"]+)(")(?=\s|>)', fr'\g<1>{image_static_src}\g<3>', attributes)
+
+    # Check if optimized image exists
+    relative_image_path_without_extension = relative_image_path.rsplit('.', 1)[0]
+    optimized_image_webp_absolute_path = find(f'{relative_image_path_without_extension}.webp')
+
+    if optimized_image_webp_absolute_path:
+        optimized_image_static_src = static(f'{relative_image_path_without_extension}.webp')
+        optimized_image_webp = f'<source srcset="{optimized_image_static_src}" type="image/webp">'
+    else:
+        optimized_image_webp = ''
+
+    # Create html picture tag
+    picture_tag = f'''
+    <picture>
+        {optimized_image_webp}
+        <img {attributes_output}>
+    </picture>
+    '''
+    return mark_safe(picture_tag)

django_img_optimizer/utils.py

@@ -0,0 +1,73 @@
+from django.conf import settings
+from glob import iglob
+import os
+from PIL import Image
+
+def get_settings():
+    """ Retrieves the optimization settings from the Django settings """
+    OPTIMIZE_IMAGE_ROOT = getattr(settings, 'OPTIMIZE_IMAGE_ROOT', None)
+    if not OPTIMIZE_IMAGE_ROOT:
+        raise Exception("Set OPTIMIZE_IMAGE_ROOT in settings.py")
+
+    OPTIMIZE_IMAGE_QUALITY = getattr(settings, 'OPTIMIZE_IMAGE_QUALITY', 100)
+    if OPTIMIZE_IMAGE_QUALITY < 0 or OPTIMIZE_IMAGE_QUALITY > 100:
+        raise Exception("Image Quality needs to be between 0 and 100")
+
+    OPTIMIZE_IMAGE_TYPES = getattr(settings, 'OPTIMIZE_IMAGE_TYPES', ['jpg', 'jpeg', 'png'])
+
+    OPTIMIZE_IMAGE_EXCLUDED_FOLDERS = getattr(settings, 'OPTIMIZE_IMAGE_EXCLUDED_FOLDERS', [])
+
+    return {
+        'OPTIMIZE_IMAGE_ROOT': OPTIMIZE_IMAGE_ROOT,
+        'OPTIMIZE_IMAGE_TYPES': OPTIMIZE_IMAGE_TYPES,
+        'OPTIMIZE_IMAGE_QUALITY': OPTIMIZE_IMAGE_QUALITY,
+        'OPTIMIZE_IMAGE_EXCLUDED_FOLDERS': OPTIMIZE_IMAGE_EXCLUDED_FOLDERS
+    }
+
+def delete_optimized_images():
+    """ Delete all optimized images. """
+    image_optimizer_settings = get_settings()
+    OPTIMIZE_IMAGE_ROOT = image_optimizer_settings.get('OPTIMIZE_IMAGE_ROOT')
+
+    for file in iglob(f'{OPTIMIZE_IMAGE_ROOT}/**', recursive=True):
+        if os.path.isfile(file):
+            file_extension = file.rsplit('.', 1)[-1]
+            if file_extension in ['webp']:
+                os.remove(file)
+
+    print('Optimized images have been deleted.')
+
+def delete_if_optimized_image_is_larger(original_file: str, output_file: str):
+    """ Compares the original image to the optimized image and deletes it they it is larger in size. """
+    file_size = os.path.getsize(original_file)
+    output_file_size = os.path.getsize(output_file)
+
+    if output_file_size >= file_size:
+        os.remove(output_file)
+
+def optimize_images():
+    """
+    Optimize images by converting them to WebP format with a specified quality (100 by default).
+    Deletes the optimized image if it is larger than the original.
+    """
+    image_optimizer_settings = get_settings()
+    OPTIMIZE_IMAGE_ROOT = image_optimizer_settings.get('OPTIMIZE_IMAGE_ROOT')
+    OPTIMIZE_IMAGE_TYPES = image_optimizer_settings.get('OPTIMIZE_IMAGE_TYPES')
+    OPTIMIZE_IMAGE_QUALITY = image_optimizer_settings.get('OPTIMIZE_IMAGE_QUALITY')
+    OPTIMIZE_IMAGE_EXCLUDED_FOLDERS = image_optimizer_settings.get('OPTIMIZE_IMAGE_EXCLUDED_FOLDERS')
+
+    for file in iglob(f'{OPTIMIZE_IMAGE_ROOT}/**', recursive=True):
+        folder_name = os.path.basename(os.path.dirname(file))
+
+        if os.path.isfile(file) and (folder_name not in OPTIMIZE_IMAGE_EXCLUDED_FOLDERS):
+            split_file_name = file.rsplit('.', 1)
+            file_path_and_name = split_file_name[0]
+            file_extension = split_file_name[-1]
+
+            if file_extension in OPTIMIZE_IMAGE_TYPES:
+                image = Image.open(file)
+                output_file = f'{file_path_and_name}.webp'
+                image.save(output_file, 'webp', quality=OPTIMIZE_IMAGE_QUALITY)
+                delete_if_optimized_image_is_larger(file, output_file)
+
+    print('Image optimization complete.')

django_img_optimizer-0.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Peter Stavrou
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

django_img_optimizer-0.0.dist-info/METADATA

@@ -0,0 +1,142 @@
+Metadata-Version: 2.1
+Name: django-img-optimizer
+Version: 0.0
+Summary: Image optimizer for Django
+Author: Peter Stavrou
+License: MIT
+Project-URL: Homepage, https://github.com/peterstavrou/django-img-optimizer
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pillow >=10.2.0
+
+# Django Image Optimizer
+
+[![pytest](https://github.com/peterstavrou/django-img-optimizer/actions/workflows/build.yml/badge.svg)](https://github.com/peterstavrou/django-img-optimizer/actions)   [![pypi](https://img.shields.io/badge/dynamic/toml?url=https://raw.githubusercontent.com/peterstavrou/django-img-optimizer/main/pyproject.toml&prefix=v&query=project.version&label=pypi&color=blue)](https://test.pypi.org/project/django-img-optimizer/)    [![mit-license](https://img.shields.io/badge/license-MIT-9d9d9d)](https://github.com/peterstavrou/django-img-optimizer/blob/main/LICENSE)
+
+Django Image Optimizer converts images to WebP format with a specified quality and automatically deletes the optimized image if it's larger than the original. This ensures efficient image optimization.
+
+## Installation
+    pip install django-img-optimizer
+
+## Configuration
+
+Add django_img_optimizer to `INSTALLED_APPS` in your projects `settings.py` file:
+
+```
+    INSTALLED_APPS = [
+        ...
+        'django_img_optimizer',
+        ...
+    ]
+```
+
+Set `OPTIMIZE_IMAGE_ROOT` to the  top-level folder which contains the images that you would like to optimize. django_img_optimizer will traverse through all of the subfolders looking for the specified image types.
+
+For example, if you have a folder inside static called images:
+
+    OPTIMIZE_IMAGE_ROOT = os.path.join(PROJECT_DIR, 'static', 'images')
+
+### Optional Settings
+
+#### Image Quality
+
+`OPTIMIZE_IMAGE_QUALITY` specifies the optimization image quality on a scale from 0 (worst) to 100 (best) The lower the quality the smaller the size of the file.
+
+Default is `100`.
+
+**Example:**
+
+    OPTIMIZE_IMAGE_QUALITY = 100
+
+---
+
+#### Image Types
+
+`OPTIMIZE_IMAGE_TYPES` specifies a list of image types that you want to optimize.
+
+Default is  `['jpg', 'jpeg', 'png']`.
+
+**Example:**
+
+    OPTIMIZE_IMAGE_TYPES = ['jpg', 'jpeg', 'png']
+
+---
+
+#### Exclude Folders
+
+`OPTIMIZE_IMAGE_EXCLUDED_FOLDERS` is used to exclude specific folders from the optimization process.
+
+Default is `None`.
+
+**Example:**
+
+    OPTIMIZE_IMAGE_EXCLUDED_FOLDERS = ['backup-larger-versions']
+
+
+## Usage
+
+###  Command line
+
+Optimize all images:
+
+    python manage.py optimize_images
+
+Delete all optimized images:
+
+    python manage.py optimize_images --delete
+
+###  Django templates
+
+Load the optimized images in Django templates:
+
+    {% load image_optimizer %}
+
+    {% optimized_image 'loading="lazy"' 'decoding="async"' 'src="images/logo.jpg"' 'alt="Logo"' 'class="img-fluid"' %}
+
+This will render:
+
+    <picture>
+        <source srcset="/static/images/logo.webp" type="image/webp">
+        <img loading="lazy" decoding="async" src="/static/images/logo.jpg" alt="Logo" class="img-fluid">
+    </picture>
+
+Pass in any `<img>` attribute by wrapping it between  single quotes `'`.
+
+You can use variables with the `optimize_image` template tag that have been passed through `include` by using the built-in Django filter [add](https://docs.djangoproject.com/en/5.0/ref/templates/builtins/#add).
+
+**Example:**
+
+In index.html
+
+    {% include 'partial/example.html' with image_name='logo'  %}
+
+In example.html
+
+    {% with src='"images/'|add:image_name|add:'.jpg"' %}
+        {% optimized_image 'src='|add:src %}
+    {% endwith %}
+
+This will render:
+
+    <picture>
+        <source srcset="/static/images/logo.webp" type="image/webp">
+        <img src="/static/images/logo.jpg">
+    </picture>
+
+#### Further explanation of example using variables with include:
+
+src is set to: `src='"images/'`
+
+The single quotes `'` around `"images/` indicates that it is a string.
+
+`|add:image_name`  adds the `image_name` variable to the string, resulting in: `src="images/logo`
+
+`|add:'.jpg"'` adds `.jpg"` to the string, resulting in: `src="images/logo.jpg"`
+
+### AVIF Image Support
+
+django_img_optimizer utilizes `python-pillow`, which currently lacks official support for AVIF files.
+
+However, there is a [pull request](https://github.com/python-pillow/Pillow/pull/5201) in progress to enable this support.

django_img_optimizer-0.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+django_img_optimizer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_img_optimizer/apps.py,sha256=3wP5TDGW1YPwCEe954pwJTdXMezqehNVXeH2AOA4Hs8,166
+django_img_optimizer/utils.py,sha256=dI6MLCzRUVL6AU0f0owd-5DoeNBxS6QadlDoj6x5r5M,3166
+django_img_optimizer/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_img_optimizer/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_img_optimizer/management/commands/optimize_images.py,sha256=c7JhzWv4PfrsZwyiJT8M2TOBr_0NVQapxb0ePh9nuSc,740
+django_img_optimizer/templatetags/image_optimizer.py,sha256=mwoYlJNfrxyAneo4gaB0V-UHYZK7zR__ksCQddMQJW0,1740
+django_img_optimizer-0.0.dist-info/LICENSE,sha256=doHY_QMZxbBq8b5kMkzUntcHrzgSHnGXMvj_qHhBupA,1069
+django_img_optimizer-0.0.dist-info/METADATA,sha256=DKdKi94V7dy5pvvJJRdZc6OxYaF-4ITVcQ4Mzx489Ek,4386
+django_img_optimizer-0.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+django_img_optimizer-0.0.dist-info/top_level.txt,sha256=vSf4W52nTSHmoJo2Vbk17Td1RhS8YNlWy4gUWo_kpsA,21
+django_img_optimizer-0.0.dist-info/RECORD,,

django_img_optimizer-0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

django_img_optimizer-0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+django_img_optimizer