Django Essentials

Essential utilities for Django that make common tasks easier and more efficient.

Features

• Admin Utilities: Enhanced admin interface components including FancyBox image display
• Model Utilities: Helper functions for common model operations

Installation

pip install django-essentials-kit

Quick Start

Admin Utilities

The library provides MediaFancybox class and get_fancybox_image function for enhanced image display in Django admin:

from django.contrib import admin
from django_essentials_kit.admin import MediaFancybox, get_fancybox_image
from .models import YourModel

@admin.register(YourModel)
class YourModelAdmin(admin.ModelAdmin):
    list_display = ['name', 'image_preview']

    class Media(MediaFancybox):
        ...

    def image_preview(self, obj) -> SafeString:
        return get_fancybox_image(obj, 'image_field', w=60, h=60)

Model Utilities

Use get_object_or_none for safe object retrieval:

from django_essentials_kit.utils import get_object_or_none

from .models import YourModel

# Instead of try/except blocks
obj = get_object_or_none(YourModel, pk=1)
if obj:
    ...  # Do something with obj

JSON Logger Formatter

Add to settings.py:

LOGGING = {
    "version": 1,
    "disable_existing_loggers": True,
    "root": {"level": "INFO", "handlers": ["console"]},
    "formatters": {
        "json": {
            "format": "[%(levelname)s][%(asctime)s] %(module)s.%(funcName)s:%(lineno)d: %(message)s",
            "()": "django_essentials_kit.logger_formatter.JSONFormatter",
        },
    },
    "handlers": {
        "console": {"level": "INFO", "class": "logging.StreamHandler", "formatter": "json"},
    },
    "loggers": {
        "django": {"level": "DEBUG", "handlers": ["console"], "propagate": False},
        # ...
    },
}

Logging HTTP request-response

Add to settings.py:

MIDDLEWARE = [
    "django_essentials_kit.middlewares.DjangoLoggingMiddleware",
    # ...
]

It will be added to the logs:

• real_client_ip if it is routable
• is_succeeded (200 <= status < 300 - true else false)
• request details:
  • status_code
  • method
  • path
• user_id if a user is signed in
• real_client_ip (if routable)

Requirements

• Python 3.8+
• Django 3.2+

License

MIT License - see LICENSE file for details.