imgproxykit

A typed Python toolkit for building imgproxy URLs.

Features

• Fully typed and checked with mypy, pyright, ty and pyrefly in strict modes
• Expressive transforms: combine option objects with concise scalar arguments
• Immutable, reusable transforms for consistent image settings across your app
• Support for named presets configured on your imgproxy server

Installation

Requires Python 3.12+ and a running imgproxy server.

pip install imgproxykit

Example

Define a WebP thumbnail once and reuse it across a product catalog:

from imgproxykit import Client, Transform
from imgproxykit.options import Gravity, Resize

client = Client('https://imgproxy.your-app.com')  # Your imgproxy server.

thumbnail = Transform(
    Resize(width=300, height=300, mode='fill'),  # Pass option objects.
    Gravity(position='sm'),  # Let imgproxy choose the crop's focus.
    quality=80,  # Or scalar, equivalent to Quality(80).
    format='webp',
)
sources = [
    'https://example.com/products/backpack.jpg',
    'https://example.com/products/sneakers.jpg',
]
thumbnail_urls = [client.url(source, transform=thumbnail) for source in sources]

Use these URLs in your images' src attributes; imgproxy handles processing.

Sign URLs and reuse presets configured on your imgproxy server:

from imgproxykit import Client, Transform
from imgproxykit.options import Preset

client = Client(
    'https://imgproxy.your-app.com',
    key='736563726574',  # Example hex credentials; use your server's values.
    salt='73616c74',
)

thumbnail = Transform(
    Preset(names=('product-card',)),
    format='webp',
)
thumbnail_url = client.url(
    'https://example.com/products/backpack.jpg',
    transform=product_card,
)

Contributing

See the contributing guide for development setup and checks. Bug reports and feature requests are welcome on the issue tracker.

License

MIT

Credits

Generated with wemake-python-package (template version).