Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

An image serializer field for use with sorl and Django REST Framework.

Project description

Build Status Coverage Status

An image serializer field for use with sorl and Django REST Framework.

Provides an easy way of exposing a scaled version of an image rather than the full-size one, and if you prefer several different versions (thumb, large etc.)



pip install sorl-thumbnail-serializer-field


pip install -e

Quick start

  1. Add 'sorl_thumbnail_serializer' to the list of installed applications in your project’s file. Make sure you have already installed and configured sorl-thumbnail and Django REST Framework as well, if not do so now.
  2. Add the HyperlinkedSorlImageField to your serializer class.
  3. Specify the image dimensions and cropping options that the REST API should use.

Example usage

from django.conf.urls import url, include
from models import TestModel
from rest_framework import routers, serializers, viewsets
from sorl_thumbnail_serializer.fields import HyperlinkedSorlImageField

class TestModelSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = TestModel

    # A thumbnail image, sorl options and read-only
    thumbnail = HyperlinkedSorlImageField(
        options={"crop": "center"},

    # A larger version of the image, allows writing
    image = HyperlinkedSorlImageField('1024')

class TestModelViewSet(viewsets.ModelViewSet):
    queryset = TestModel.objects.all()
    serializer_class = TestModelSerializer

router = routers.DefaultRouter()
router.register(r'test_models', TestModelViewSet)

urlpatterns = [
    url(r'^', include(router.urls)),

Project details

Download files

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

Files for sorl-thumbnail-serializer-field, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size sorl_thumbnail_serializer_field-0.2.1-py2.py3-none-any.whl (14.0 kB) File type Wheel Python version 3.5 Upload date Hashes View
Filename, size sorl-thumbnail-serializer-field-0.2.1.tar.gz (8.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page