django-anchor 0.4.0

Attach files to Django models

Django Anchor

A reusable Django app to handle files attached to models, inspired by Ruby on Rails' excellent Active Storage.

Features

• Attach images and other files to your models. Supports one or more individual files per model as well as multiple ordered collections of files.
• Optimized storage. Deduplicates files for optimized storage
• Display files in templates. Render resized thumbnails and optimized versions of your images in templates via a template tag.
• Reduce external dependencies. Django anchor doesn't need any external services and works Django's local file storage.

Limitations

• Files are prefixed with a random string which makes the URLs for them hard to guess, but they are currently not protected against unauthorized attacks.
• It only works with Django storage classes in which files are accessible via the file system, i.e. where the path property of a file is implemented.
• It currently depends on Huey for background processing.

Future work

• Remove dependency on base58
• Implement private file links (maybe via signed URLs?)
• Support for async/delayed variant generation
• Reduce number of dependencies:
  • Make PIL dependency optional

Installation

Django-anchor is compatible with Django >= 4.2 and Python >= 3.10.

1. Add the django-anchor package to your dependencies. You can do this by running:

   pip install django-anchor
   

   or by adding django-anchor to your requirements.txt or pyproject.toml files if you have one.

2. Add anchor to settings.INSTALLED_APPS

In addition, if you wish to create image variants, a Pillow >= 8.4 should be available in your system.

Usage

💡 Check out the demo Django project for inspiration and the Getting Started guide in the documentation.

Adding files to models

The easiest way to add a file to a model is to add a BlobField to it:

from django.db import models
from anchor.models.fields import BlobField


class Movie(models.Model):
    title = models.CharField(max_length=100)

    # A compulsory field that must be set on every instance
    cover = BlobField()

    # An optional file that can be left blank
    poster = BlobField(blank=True, null=True)

Notice how the BlobField above can be customized by setting the blank and null options like any other field. It will also accept any other core field parameters.

BlobFields are ForeignKey fields under the hood, so after you've added or made changes you need to generate a migration with python manage.py makemigrations and then apply it via python manage.py migrate.

Once your migrations are applied you can assign an anchor.models.blob.Blob object to a BlobField much like you'd assign a DjangoFile object to a FileField:

from anchor.models.blob import Blob

# A new Blob objects is created and saved to the database with the file metadata
cover = Blob.objects.from_url('...')

# Make our movie point to that Blob object
movie.cover = cover
movie.save()

Using files in templates

Django anchor comes with a handy template tag to render URLs of files you've stored:

{% load anchor %}
<img src="{% blob_thumbnail movie.poster max_width=300 max_height=600 format='jpeg' %}">

The above call to blob_thumbnail will generate an optimized version of the movie's cover in JPEG format which fits inside a 300x600 rectangle. Optimized versions are generated asynchronously and if they're not ready for immediate use the original file's URL is returned instead to avoid blocking the request.

Contributing

PRs and issues are very welcome!

Check out CONTRIBUTING.md to learn how to set up the project locally.

License

This project is released under the MIT License. Check out LICENSE to get the full text of the license.