Tinify API client for Python

Features

Requirements

Installation

pip install tinify

Quick start

import tinify
# Set your API key (get one for free at https://tinypng.com/developers)
tinify.key = "YOUR_API_KEY"
# Compress an image from a file
tinify.from_file("unoptimized.png").to_file("optimized.png")
# Compress from URL
tinify.from_url("https://example.com/image.jpg").to_file("optimized.jpg")
# Compress from buffer
source_data = b"<image data>"
tinify.from_buffer(source_data).to_file("optimized.jpg")

Advanced Usage

Resizing

# Scale image to fit within 300x200px while preserving aspect ratio
tinify.from_file("original.jpg").resize(
 method="scale",
 width=300,
 height=200
).to_file("resized.jpg")
# Fit image to exact 300x200px dimensions
tinify.from_file("original.jpg").resize(
 method="fit",
 width=300,
 height=200
).to_file("resized.jpg")
# Cover 300x200px area while preserving aspect ratio
tinify.from_file("original.jpg").resize(
 method="cover",
 width=300,
 height=200
).to_file("resized.jpg")

Format Conversion

# Convert to WebP format
tinify.from_file("image.png").convert(
 type=["image/webp"]
).to_file("image.webp")

# Convert to smallest format
converted = tinify.from_file("image.png").convert(
 type=["image/webp", "image/webp"]
)
extension = converted.result().extension
converted.to_file("image." + extension)

Compression Count Monitoring

# Check the number of compressions made this month
compression_count = tinify.compression_count
print(f"You have made {compression_count} compressions this month")

Error Handling

import tinify
tinify.key = "YOUR_API_KEY"
try:
 tinify.from_file("unoptimized.png").to_file("optimized.png")
except tinify.AccountError as e:
 # Verify or update API key
 print(f"Account error: {e.message}")
except tinify.ClientError as e:
 # Handle client errors (e.g., invalid image)
 print(f"Client error: {e.message}")
except tinify.ServerError as e:
 # Handle server errors
 print(f"Server error: {e.message}")
except tinify.ConnectionError as e:
 # Handle network connectivity issues
 print(f"Connection error: {e.message}")
except Exception as e:
 # Handle general errors
 print(f"Error: {str(e)}")

Running tests

pip install -r requirements.txt -r test-requirements.txt
py.test

tox

Integration tests

pip install -r requirements.txt -r test-requirements.txt
TINIFY_KEY=$YOUR_API_KEY py.test test/integration.py

License

Support