Create a centered square crop

Before you begin

Python 3.12 or newer
Pillow installed in the same Python environment

What this script changesCreates new image files or a new frame directory. Inputs and outputs are limited to 20 million pixels per image; animated tasks also cap frame count. Ordinary transforms process the first frame and normalize EXIF orientation. Color profiles and original metadata are not preserved reliably; use source copies for archival work.

Set up your example

Save the complete code as image-center-square.py in a working folder.
Save the provided sample files in that same folder; run commands from that folder.
Install Pillow: python -m pip install Pillow
Generate the original fixtures once: python "make_samples.py". Choose an empty folder so the fixture files do not exist.

Sample files in this download:

make_samples.py

Download the ZIP, extract it, and open a terminal inside the extracted folder. The source file is image-center-square.py.

Run the script

python "image-center-square.py" --input "sample.png" --output "square.png"

If your system uses python3 instead of python, use that command for Python examples. Keep paths containing spaces in quotes. Required inputs and optional settings are described in the code and setup steps.

What to expect

Create a square avatar crop without stretching. The fixture becomes a 100 by 100 square.

The complete script

#!/usr/bin/env python3
'Create a centered square crop'
import argparse
import json
from pathlib import Path

def write_json(path, value):
    data = json.dumps(value, indent=2, ensure_ascii=False, allow_nan=False) + "\n"
    with Path(path).open("x", encoding="utf-8", newline="") as handle:
        handle.write(data)

import math

try:
    from PIL import Image, ImageOps, ImageEnhance, ImageFilter, ImageDraw, ImageFont, ImageChops
except ImportError:
    raise SystemExit("Install Pillow first: python -m pip install Pillow")
MAX_PIXELS=20_000_000
def check_size(size):
    if min(size)<1 or size[0]*size[1]>MAX_PIXELS:
        raise ValueError("Image dimensions must be positive and at most 20 million pixels.")
def read_image(path):
    with Image.open(path) as original:
        check_size(original.size)
        return ImageOps.exif_transpose(original).convert("RGBA")
def save_image(path,image,format="PNG"):
    check_size(image.size)
    with Path(path).open("xb") as handle:
        image.save(handle,format=format)

def main():
    parser = argparse.ArgumentParser(description='Create a centered square crop')
    parser.add_argument("--input",required=True,help="Local source image")
    parser.add_argument("--output",required=True,help="New output file or directory")
    args = parser.parse_args()
    image=read_image(args.input)
    side=min(image.size)
    left=(image.width-side)//2
    top=(image.height-side)//2
    save_image(args.output,image.crop((left,top,left+side,top+side)))

if __name__ == "__main__":
    try:
        main()
    except (OSError, ValueError, KeyError, TypeError, ArithmeticError, IndexError, LookupError) as exc:
        raise SystemExit(str(exc))

Open source as plain text · Download source and sample files

How it works

Pillow reads the local image; the source is left unchanged and existing destinations are refused.
The shorter source dimension determines the square size and equal margins are removed from the longer dimension.
The fixture becomes a 100 by 100 square.

Make it your own

--input

Choose a portrait or landscape source for a centered avatar.

Adapt the processing

Edit main's left and top calculations to favor a known subject position.

Change one setting at a time, run it again on sample data, and compare the output. The customization guide walks through this process.

If something goes wrong

A face is cropped out.

The crop is geometric rather than subject-aware; use image-crop-box to choose the subject explicitly.

The destination already exists.

Choose a new --output path. The script deliberately refuses to replace an existing result.

Reference & next steps

These official references explain the underlying tools. The Scriptage example and guide are original instructional content. See verification notes for what has been checked and the limits of those checks.

Copies a template for your own notes. It does not send anything.