ImgProxy
ImgProxy -- Python library to build ImgProxy URLs
Features
Table of Contents
Requirements
- python >= 3.7
Installation
imgproxy should be installed using pip:
$ pip install imgproxy
Usage
from imgproxy import ImgProxy
# Create ImgProxy object with required params
img_url = ImgProxy('https://picsum.photos/1000', proxy_host='https://imgproxy.com', width=800, height=400)
# Convert the obj to string to get imgproxy URL
cover: str = str(img_url)
# or just call it to get imgproxy URL
cover: str = img_url()
assert cover == 'https://imgproxy.com/insecure/g:ce/rs:auto:800:400:0/aHR0cHM6Ly9waWNzdW0ucGhvdG9zLzEwMDA'
# Call the object with different params to customize the url
cover_small: str = img_url(width=400, height=200, resizing_type='fill')
assert cover_small == 'https://imgproxy.com/insecure/g:ce/rs:fill:400:200:0/aHR0cHM6Ly9waWNzdW0ucGhvdG9zLzEwMDA'
# Call it with advanced params to get an URL
cover_with_border = img_url('pd:10:10:10:10', 'bg:F00')
assert cover_with_border == 'https://imgproxy.com/insecure/pd:10:10:10:10/bg:F00/g:ce/rs:auto:0:0:0/aHR0cHM6Ly9waWNzdW0ucGhvdG9zLzEwMDA'
Options
Basic options (default values):
width: int = 0- images widthheight: int = 0- images heightgravity: str = 'ce'- images gravityenlarge: bool = False- enlarge an imageextension: str = ''- images extensionresizing_type: str = 'auto'- resizing type
from imgproxy import ImgProxy
img_url = ImgProxy('https://picsum.photos/1000', proxy_host='https://imgproxy.com')
thumbmail = img_url(width=100, height=100, gravity='no', extension='jpg', enlarge=True, resizing_type='fit')
Any other options are also supported when you call an imageproxy instance:
from imgproxy import ImgProxy
img_url = ImgProxy('https://picsum.photos/1000', proxy_host='https://imgproxy.com')
# Get rotated and blured image
blured_rotated = img_url('blur:0.5', 'rotate:30')
Signed URLs
Imgproxy allows you to sign your URLs with key and salt, so an attacker won’t be able to cause a denial-of-service attack by requesting multiple different image resizes.
from imgproxy import ImgProxy
url = ImgProxy('https://picsum.photos/1000', proxy_host='https://imgproxy.com', key="aa396160c50ea766910eab53", salt="b3fb8f215827bda5d0e7313d")
assert str(url) == 'https://imgproxy.com/FrH21u_5bXmv-OJ0APMayxZ0F3982xx437gCpqcQ0BM/g:ce/rs:auto:600:0:0/aHR0cHM6Ly9waWNzdW0ucGhvdG9zLzEwMDA'
If you need a random key/salt pair real fast, you can quickly generate it using, for example, the following snippet:
echo $(xxd -g 2 -l 64 -p /dev/random | tr -d '\n')
Image factories
Usually imgproxy host and signature params are common for a project. The library supports a method to generate a factory with predefined params:
from imgproxy import ImgProxy
img_factory = ImgProxy.factory(proxy_host='https://imgproxy.com', key="aa396160c50ea766910eab53", salt="b3fb8f215827bda5d0e7313d")
# ...
# Generate image URL
url = img_factory('https://picsum.photos/1000', width=600)
assert str(url) == 'https://imgproxy.com/qcKAFfBJwpiKZ6xt-NT6GXGOGizkeq4sgyfoQ4h-080/g:ce/rs:auto:600:0:0/aHR0cHM6Ly9waWNzdW0ucGhvdG9zLzEwMDA'
Users able to predifine any basic params:
thumbnail_factory = ImgProxy.factory(proxy_host='https://imgproxy.com', width=300, height=200)
preview_factory = ImgProxy.factory(proxy_host='https://imgproxy.com', width=500, resizing_type='fit')
# and etc
Advanced params are also supported:
thumbnail_factory = ImgProxy.factory('bg:F00', 'pd:10:10:10:10', proxy_host='https://imgproxy.com', width=300, height=200)
Changelog
-
2021-11-08: [1.0.0]
- Support python 3.10
- Support advanced options in factories
-
2021-09-14: [0.4.0]
- Support python 3.7
- Basic format has been removed (it's depricated in ImgProxy)
-
2021-04-02: [0.2.3] Stable release
Bug tracker
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/imgproxy/issues
Contributing
Development of the project happens at: https://github.com/klen/imgproxy
License
Licensed under a MIT License
Metadata
Release files for imgproxy 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| imgproxy-1.0.0.tar.gz | 4.6 kB | Without provenance | Details for imgproxy-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| imgproxy-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for imgproxy-1.0.0-py3-none-any.whl |
Total release size: 9.1 kB
Release files / imgproxy-1.0.0.tar.gz
| Download URL | imgproxy-1.0.0.tar.gz |
|---|---|
| Size | 4.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f2e34b0da688284ad3a1e7ccd907b1038285001832362fb64cd2bd39c6c952e3
|
|
BLAKE2b-256 checksum How to use checksums |
cd5b1a12a2c5af1f1c42133b126811cf2f382ac21ed46cd86ca9c5fca338840e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
|
Release files / imgproxy-1.0.0-py3-none-any.whl
| Download URL | imgproxy-1.0.0-py3-none-any.whl |
|---|---|
| Size | 4.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
18d3686c1b8f976906192e7bbdcd44dca305600e3e338fab68c30ee9a4102ded
|
|
BLAKE2b-256 checksum How to use checksums |
e3177188d1a8030966ab01c817e7dffe8dd745098e9ce2998cc966616479179b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
|
Security for imgproxy 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.