Skip to main content

A simple interface that allows processing of images.

Project description

variations

A simple interface that allows processing of images.

PyPI Build Status Software license

Compatibility

  • python >= 3.7

Installation

  1. Run pip install variations

  2. (optional) If you want to use StackBlur

    pip install pillow-stackblur

  3. (optional) If you want to use Face Detection

    pip install face_recognition

Usage

from PIL import Image
from variations import processors
from variations.variation import Variation
from variations.utils import prepare_image

variation = Variation(
    size=(400, 0),
    max_height=800,
    clip=False,
    upscale=False,
    anchor=processors.Anchor.TOP_LEFT,
    jpeg=dict(
        quality=92,
    ),
    webp=dict(
        lossless=True,
        quality=90,
    ),
    postprocessors=[
        processors.ColorOverlay('#FF0000', overlay_opacity=0.25),
    ],
)

img = Image.open('source.jpg')
img = prepare_image(img, draft_size=variation.get_output_size(img.size))
new_img = variation.process(img)
dest_path = variation.replace_extension('dest.jpg')
variation.save(new_img, dest_path)

Options

Type Examples Description
size tuple
list
(640, 480)
(640, 0)
The canvas size of image. If you set the width or height to zero, the corresponding value will be automatically adjusted based on the aspect ratio
max_width int 640 It specifies the maximum width in pixels.This option have meaning only when corresponding value in size is zero
max_height int 480 It specifies the maximum height in pixels.This option have meaning only when corresponding value in size is zero
clip bool When set to True, the image can be cropped when filling the canvas.
upscale bool When set to True, the image can be upscaled when filling the canvas.
anchor str
tuple
list
'tr' (top right)
'c' (center)
(1, 1) (bottom right)
Defines the anchor point.
face_detection bool Use a face detection system to find anchor point. You must install facial recognition api to use this.
format str 'JPEG' 'png' 'WebP' Enforce output image format. Defaults to 'AUTO', which means keep input format.
preprocessors list [processors.Crop(width=200, height=120, x=50, y=50)] PilKit processors are invoked before the main processing stage
postprocessors list [processors.ColorOverlay('#0000FF', 0.10)] PilKit processors are invoked after the main processing stage

Additional options for specific formats

It is possible to pass additional options to Image.save() method.

Variation(
    # ...
    jpeg=dict(
        quality=80,
        progressive=True,
    ),
    webp=dict(
        autoconvert=False,
        quality=80,
    ),
    tiff=dict(
        compression='tiff_jpeg',
    )
)

Development and Testing

After cloning the Git repository, you should install this in a virtualenv and set up for development:

virtualenv .venv
source .venv/bin/activate
pip install -r ./requirements.txt
pre-commit install

Project details


Download files

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

Source Distribution

variations-0.3.3.tar.gz (19.4 kB view hashes)

Uploaded Source

Built Distribution

variations-0.3.3-py2.py3-none-any.whl (15.7 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page