Skip to main content

A Django middleware to optimize image uploads by converting them to WebP.

Project description

Django Image Optimizer

A Django middleware and utility for optimizing uploaded images by converting them to WebP with configurable width, height, and quality settings.

Features

Automatic optimization via middleware
Manual optimization via utility function
Supports per-request overrides
Configurable defaults via settings.py


Installation

pip install django-image-optimizer

Add the middleware:

MIDDLEWARE = [
    # other middleware...
    "optimizer_middleware.middleware.ImageOptimizationMiddleware",
]

Configuration

Set global defaults in settings.py:

# Default image optimization settings
IMAGE_OPTIMIZER_WIDTH = 800   # Resize width
IMAGE_OPTIMIZER_HEIGHT = None  # Keep aspect ratio
IMAGE_OPTIMIZER_QUALITY = 80  # WebP quality

By default, images are resized to 800px width while maintaining aspect ratio and optimized to 80% quality.


Usage

1️⃣ Automatic Optimization (Middleware)

Once added to MIDDLEWARE, the optimizer automatically processes all uploaded images in POST, PUT, and PATCH requests.

✅ Converts images to WebP
✅ Resizes based on settings.py


2️⃣ Dynamic Overrides (Per Request)

Override optimization settings dynamically in a view using request.META:

def upload_view(request):
    request.META["IMAGE_OPTIMIZER_WIDTH"] = 600
    request.META["IMAGE_OPTIMIZER_QUALITY"] = 90
    return some_response

3️⃣ Manual Optimization (Standalone Function)

Use the function anywhere in your code (views, forms, serializers, etc.).

from optimizer_middleware.utils import optimize_image

optimized_image = optimize_image(image_file, width=500, quality=85)

License

MIT License. Free to use and modify. 🚀


Contribution

Use this guide Contribution

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-optimize-image-0.2.1.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_optimize_image-0.2.1-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file django-optimize-image-0.2.1.tar.gz.

File metadata

  • Download URL: django-optimize-image-0.2.1.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for django-optimize-image-0.2.1.tar.gz
Algorithm Hash digest
SHA256 217e75bc4a61a854f4cd94280ed8f4b2a64ee3e94f481d26a07fe059cedb34bc
MD5 c48569ce9f9bc7448ce3f08729c20b6c
BLAKE2b-256 e35f3a239a8ae605a0f7689b31b07116a5ff170a9c6fcbdf9ed0c9cf1d76a877

See more details on using hashes here.

File details

Details for the file django_optimize_image-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_optimize_image-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d7c916662cb16538a195505b60863098428f6a41a4f0f9fd2cb390796cfdfaec
MD5 b4f150cbbbddab9c73144180a5e1becc
BLAKE2b-256 11fb5e84244b3ab8c3ccfcbbc32d81318f64393d90edd82e82eeb7b2e098fa2b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page