update docstring

Author: agusmakmun

README.rst

@@ -2,16 +2,16 @@ django-image-optimizer |pypi version|
 ---------------------------------------
 
 .. |pypi version|
-   image:: https://img.shields.io/pypi/v/django-image-optimizer.svg?style=flat-square
+   image:: https://img.shields.io/pypi/v/django-image-optimizer.svg
    :target: https://pypi.python.org/pypi/django-image-optimizer
 
-.. image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
+.. image:: https://img.shields.io/badge/license-MIT-blue.svg
    :target: https://raw.githubusercontent.com/agusmakmun/django-image-optimizer/master/LICENSE
 
-.. image:: https://img.shields.io/pypi/pyversions/django-image-optimizer.svg?style=flat-square
+.. image:: https://img.shields.io/pypi/pyversions/django-image-optimizer.svg
    :target: https://pypi.python.org/pypi/django-image-optimizer
 
-.. image:: https://img.shields.io/badge/Django-1.8,%201.9,%201.10,%201.11,%202.0-green.svg?style=flat-square
+.. image:: https://img.shields.io/badge/Django-1.8%20%3E=%203.0-green.svg
   :target: https://www.djangoproject.com
 
 
@@ -80,13 +80,51 @@ file. Note: it is a good idea to keep this secret
         image = OptimizedImageField()
 
 
+    class MyModel2(models.Model):
+        """
+        If you using OPTIMIZED_IMAGE_METHOD = 'pillow'
+        You can use this optional arguments.
+
+        This model represents a MyModel2 with a few
+        fields including a `image` field which is an OptimizedImageField
+        instance with `optimized_image_output_size` and
+        `optimized_image_resize_method` arguments set.
+
+        This means that image would be a resized
+        version of the source image, meant to keep a given screen resolution,
+        in this case (400, 300) pixels.
+        """
+        image = OptimizedImageField(
+            upload_to='uploads/collaborators/%Y/%m/%d',
+            optimized_image_output_size=(400, 300),
+            optimized_image_resize_method='cover'  # 'thumbnail', 'cover' or None
+        )
+
+
 and saving images into it, the same way you would to a Django ``ImageField``.
 The optimized image will be saved into the ``url`` field in place of the
 unoptimized image.
 
 
+5. Or you can directly use the ``image_optimizer`` function from utils.
+
+::
+
+    from image_optimizer.utils import image_optimizer
+
+
+    def post_image(request):
+        image_data = request.FILES.get('image')
+        image_data = image_optimizer(image_data=image_data,
+                                     output_size=(400, 300),
+                                     resize_method='cover')
+        ....
+
+
+**P.S:**
+
  Note about TinyPNG API keys: If you obtain the free TinyPNG API token, you are limited to 500
  image optimizations per month, so this function may fail if you have a
  lot of images. You may either obtain a paid API key, or wait until next month.
 
-This project also taken from: https://github.com/dchukhin/django_optimized_image
+This project forked from: https://github.com/dchukhin/django_optimized_image

image_optimizer/fields.py

@@ -2,6 +2,7 @@
 from __future__ import unicode_literals
 
 from django.db.models import ImageField
+from .utils import image_optimizer
 
 
 class OptimizedImageField(ImageField):
@@ -13,7 +14,6 @@ def save_form_data(self, instance, data):
         updating_image = True if data and getattr(instance, self.name) != data else False
 
         if updating_image:
-            from .utils import image_optimizer
             data = image_optimizer(
                 data,
                 self.optimized_image_output_size,
@@ -34,6 +34,7 @@ def __init__(self, optimized_image_output_size=None,
         # Set the optimized_image_output_size specified on your
         # OptimizedImageField model instances
         self.optimized_image_output_size = optimized_image_output_size
+
         # Set the optimized_image_resize_method specified on your
         # OptimizedImageField model instances
         self.optimized_image_resize_method = optimized_image_resize_method
@@ -49,10 +50,11 @@ def deconstruct(self):
         field but you need to exclude them from migrations.
         """
         name, path, args, kwargs = super().deconstruct()
-        if kwargs.get('optimized_image_output_size') is not None:
-            del kwargs["optimized_image_output_size"]
 
-        if kwargs.get('optimized_image_resize_method') is not None:
-            del kwargs["optimized_image_resize_method"]
+        if kwargs.get('optimized_image_output_size'):
+            del kwargs['optimized_image_output_size']
+
+        if kwargs.get('optimized_image_resize_method'):
+            del kwargs['optimized_image_resize_method']
 
         return name, path, args, kwargs

image_optimizer/utils.py

@@ -6,10 +6,12 @@
 from resizeimage import resizeimage
 
 import tinify
+import logging
 import requests
 
 from .settings import (OPTIMIZED_IMAGE_METHOD, TINYPNG_KEY)
 
+
 BACKGROUND_TRANSPARENT = (255, 255, 255, 0)
 
 
@@ -34,7 +36,13 @@ def get_image_extension(image):
 
 
 def image_optimizer(image_data, output_size=None, resize_method=None):
-    """Optimize an image that has not been saved to a file."""
+    """
+    Optimize an image that has not been saved to a file.
+    :param `image_data` is image data, e.g from request.FILES['image']
+    :param `output_size` is float pixel scale of image (width, height) or None, e.g: (400, 300)
+    :param `resize_method` is string resize method, choices are: None, "thumbnail", or "cover".
+    :return optimized image data.
+    """
     if OPTIMIZED_IMAGE_METHOD == 'pillow':
         image = Image.open(image_data)
         bytes_io = BytesIO()
@@ -45,57 +53,31 @@ def image_optimizer(image_data, output_size=None, resize_method=None):
         # resize_method. 'thumbnail' is used by default
         if output_size is not None:
 
-            if resize_method is None:
-                pass
+            if resize_method not in ('thumbnail', 'cover', None):
+                message = 'optimized_image_resize_method misconfigured, it\'s value must be \'thumbnail\', \'cover\' or None'
+                raise Exception(message)
 
             elif resize_method is 'thumbnail':
-                image = resizeimage.resize_thumbnail(
-                    image,
-                    output_size,
-                    resample=Image.LANCZOS
-                )
+                image = resizeimage.resize_thumbnail(image, output_size, resample=Image.LANCZOS)
 
             elif resize_method is 'cover':
-                image = resizeimage.resize_cover(
-                    image,
-                    output_size,
-                    validate=False
-                )
-
-            else:
-                raise Exception(
-                    'optimized_image_resize_method misconfigured, it\'s value must be \'thumbnail\', \'cover\' or None'
-                )
-
-            output_image = Image.new(
-                'RGBA',
-                output_size,
-                BACKGROUND_TRANSPARENT
-            )
-
-            output_image_center = (
-                int((output_size[0] - image.size[0]) / 2),
-                int((output_size[1] - image.size[1]) / 2)
-            )
-
-            output_image.paste(
-                image,
-                output_image_center
-            )
-
-        # If output_size is None the output_image would be the same as source
+                image = resizeimage.resize_cover(image, output_size, validate=False)
+
+            output_image = Image.new('RGBA', output_size, BACKGROUND_TRANSPARENT)
+            output_image_center = (int((output_size[0] - image.size[0]) / 2),
+                                   int((output_size[1] - image.size[1]) / 2))
+
+            output_image.paste(image, output_image_center)
+
         else:
+            # If output_size is None the output_image would be the same as source
             output_image = image
 
         # If the file extension is JPEG, convert the output_image to RGB
         if extension == 'JPEG':
-            output_image = output_image.convert("RGB")
+            output_image = output_image.convert('RGB')
 
-        output_image.save(
-            bytes_io,
-            format=extension,
-            optimize=True
-        )
+        output_image.save(bytes_io, format=extension, optimize=True)
 
         image_data.seek(0)
         image_data.file.write(bytes_io.getvalue())
@@ -105,9 +87,15 @@ def image_optimizer(image_data, output_size=None, resize_method=None):
         # disable warning info
         requests.packages.urllib3.disable_warnings()
 
+        # just info for people
+        if any([output_size, resize_method]):
+            message = '[django-image-optimizer] "output_size" and "resize_method" only for OPTIMIZED_IMAGE_METHOD="pillow"'
+            logging.info(message)
+
         tinify.key = TINYPNG_KEY
         optimized_buffer = tinify.from_buffer(image_data.file.read()).to_buffer()
         image_data.seek(0)
         image_data.file.write(optimized_buffer)
         image_data.file.truncate()
+
     return image_data

image_optimizer_demo/image_optimizer_demo/settings.py

@@ -11,6 +11,7 @@
 """
 
 import os
+import tempfile
 
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
@@ -27,7 +28,7 @@
 
 ALLOWED_HOSTS = ['*']
 
-OPTIMIZED_IMAGE_METHOD = 'tinypng'  # 'pillow'
+OPTIMIZED_IMAGE_METHOD = 'pillow'  # 'tinypng'
 TINYPNG_KEY = 'key-key-key-key'
 
 
@@ -123,7 +124,6 @@
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/2.0/howto/static-files/
 
-import tempfile
 
 STATIC_URL = '/static/'
 MEDIA_URL = '/media/'

setup.py

@@ -2,7 +2,7 @@
 
 from setuptools import (setup, find_packages)
 
-__VERSION__ = '1.0.0'
+__VERSION__ = '1.0.1'
 __AUTHOR__ = 'Agus Makmun (Summon Agus)'
 __AUTHOR_EMAIL__ = '[email protected]'
 
@@ -43,6 +43,7 @@
         'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3.3',
         'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.7',
         'Topic :: Software Development :: Libraries :: Python Modules',
         'License :: OSI Approved :: MIT License',
     ],