django-advance-thumbnail 1.1.0

A Django app that automates thumbnail creation for image fields.

Django Advance Thumbnail

Django Advance Thumbnail is a Django app that automates thumbnail creation for image fields. It generates, updates, and deletes thumbnails based on the source image, and allows custom thumbnail sizes.

Installation

1. Install the package using pip:

pip install django_advance_thumbnail

Note: Starting from version 1.1.0, this package uses the modern pyproject.toml configuration instead of the legacy setup.cfg. See MIGRATION_GUIDE.md for details.

2. Add django_advance_thumbnail to your INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
    # ...
    'django_advance_thumbnail',
    # ...
]

Usage

Here's a basic example of how to use the AdvanceDJThumbnailField in a model:

from django.db import models

from django_advance_thumbnail import AdvanceThumbnailField


class MyModel(models.Model):
    image = models.ImageField(upload_to='images/', null=True, blank=True)
    thumbnail = AdvanceThumbnailField(source_field='image', upload_to='thumbnails/', null=True, blank=True,
                                      size=(300, 300)) 

In this example, AdvanceDJThumbnailField is used to create a thumbnail from the image field. Whenever an image is uploaded or updated, a corresponding thumbnail is automatically generated and stored in the thumbnail field. The thumbnail's dimensions are determined by the optional size parameter, which defaults to (300, 300) if not specified.

This setup ensures that the lifecycle of the thumbnail is tied to its source image. If the source image is deleted, the associated thumbnail is also removed. This seamless synchronization simplifies image management in your Django models.

Advanced Features

Management Commands

Generate Thumbnails for Existing Images

When adding AdvanceThumbnailField to existing models in production:

# Generate thumbnails for all models
python manage.py generate_thumbnails

# Generate for specific model
python manage.py generate_thumbnails --model myapp.MyModel

# Force regenerate existing thumbnails
python manage.py generate_thumbnails --force

Regenerate Thumbnails After Size Changes

When you change the size parameter:

# Regenerate thumbnails with new sizes
python manage.py regenerate_thumbnails

# Force regenerate all thumbnails
python manage.py regenerate_thumbnails --force

Automatic Size Change Detection

The field automatically detects when thumbnail sizes change and regenerates them accordingly:

class MyModel(models.Model):
    image = models.ImageField(upload_to='images/', null=True, blank=True)
    thumbnail = AdvanceThumbnailField(
        source_field='image', 
        upload_to='thumbnails/', 
        null=True, 
        blank=True,
        size=(400, 400)  # Changed from (300, 300) - will auto-regenerate
    )

Smart Regeneration

By default, thumbnails are only regenerated when:

• The source image changes (detected automatically)
• The thumbnail size parameter changes
• The thumbnail doesn't exist

thumbnail = AdvanceThumbnailField(
    source_field='image', 
    upload_to='thumbnails/', 
    null=True, 
    blank=True,
    size=(300, 300)  # Efficient - only regenerates when needed
)

Force Regeneration (Override)

Use force_regenerate=True only if you need to regenerate thumbnails on every save (not recommended for production):

thumbnail = AdvanceThumbnailField(
    source_field='image', 
    upload_to='thumbnails/', 
    null=True, 
    blank=True,
    size=(300, 300),
    force_regenerate=True  # Regenerates on every save - use sparingly
)

For detailed usage instructions, see the Usage Guide.

Contact

For any questions or feedback, feel free to reach out:

• Email: [e-mail], [e-mail]
• Github: @itsmahadi007
• Linkedin: Mahadi Hassan
• Web: mahadihassan.com

Credits

This package was created by Mahadi Hassan. Special thanks to the Django and Python communities for their invaluable resources and support.