Metadata-Version: 1.1
Name: sorl-thumbnail-serializer-field
Version: 0.2
Summary: An image serializer field for use with sorl and Django REST Framework.
Home-page: https://github.com/dessibelle/sorl-thumbnail-serializer-field
Author: Simon Fransson
Author-email: simon@dessibelle.se
License: MIT License
Download-URL: https://github.com/dessibelle/sorl-thumbnail-serializer-field/archive/0.1.tar.gz
Description-Content-Type: UNKNOWN
Description: Sorl  Thumbnail Serializer Field
        ===============================
        
        [![Build Status](https://travis-ci.org/dessibelle/sorl-thumbnail-serializer-field.svg?branch=master)](https://travis-ci.org/dessibelle/sorl-thumbnail-serializer-field) [![Coverage Status](https://coveralls.io/repos/github/dessibelle/sorl-thumbnail-serializer-field/badge.svg?branch=master)](https://coveralls.io/github/dessibelle/sorl-thumbnail-serializer-field?branch=master)
        
        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.)
        
        Installation
        ------------
        
        ### PyPI
        
        ```sh
        pip install sorl-thumbnail-serializer-field
        ```
        
        ### Github
        
        ```sh
        pip install -e git+git@github.com:dessibelle/sorl-thumbnail-serializer-field.git@master#egg=sorl_thumbnail_serializer
        ```
        
        Quick start
        -----------
        
        1. Add `'sorl_thumbnail_serializer'` to the list of installed applications in your project's `settings.py` file. Make sure you have already installed and configured [sorl-thumbnail](https://github.com/mariocesar/sorl-thumbnail) and [Django REST Framework](http://www.django-rest-framework.org) 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
        -------------
        
        ```python
        # urls.py
        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(
                '128x128',
                options={"crop": "center"},
                source='image',
                read_only=True
            )
        
            # 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)),
        ]
        ```
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
