imgproxykit 0.1.0__py3-none-any.whl

imgproxykit-0.1.0.dist-info/METADATA

@@ -0,0 +1,150 @@
+Metadata-Version: 2.4
+Name: imgproxykit
+Version: 0.1.0
+Summary: A typed Python toolkit for building imgproxy URLs
+License-Expression: MIT
+License-File: LICENSE
+Keywords: image-processing,image-transformation,images,imgproxy,url-builder
+Author: Alexander Kondratev
+Author-email: mail@kondratev.dev
+Requires-Python: >=3.12,<4
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: typing-extensions (>=4.16,<5)
+Project-URL: Changelog, https://github.com/kondratevdev/imgproxykit/releases
+Project-URL: GitHub, https://github.com/kondratevdev/imgproxykit
+Project-URL: Issues, https://github.com/kondratevdev/imgproxykit/issues
+Description-Content-Type: text/markdown
+
+<h1 align="center">imgproxykit</h1>
+
+<p align="center">
+  <em>A typed Python toolkit for building imgproxy URLs.</em>
+</p>
+
+<p align="center">
+  <a href="#features">Features</a> ·
+  <a href="#installation">Installation</a> ·
+  <a href="#example">Example</a> ·
+  <a href="https://github.com/kondratevdev/imgproxykit/issues">Issues</a> ·
+  <a href="CONTRIBUTING.md">Contributing</a>
+</p>
+
+Define image transformations in Python and turn them into reusable, signed URLs.
+Your imgproxy server fetches and processes the image when the URL is requested.
+
+## Features
+
+- [x] Typed API with annotations
+- [x] Immutable, reusable transforms built from Python dataclasses
+- [x] Free imgproxy processing options, including geometry, filters, metadata,
+      quality, pixel density, gravity, and watermarks
+- [x] Output format selection, including WebP and AVIF
+- [x] Support for named presets configured on your imgproxy server
+
+## Installation
+
+Requires **Python 3.12+** and a running imgproxy server.
+
+```bash
+pip install imgproxykit
+```
+
+## Example
+
+Create a client, define a transform, and generate a URL:
+
+```pycon
+>>> from imgproxykit import Client, Transform
+>>> from imgproxykit.options import Quality, Resize
+>>> client = Client('https://images.example.com')
+>>> thumbnail = Transform(
+...     options=(
+...         Resize(width=300, height=300, mode='fill'),
+...         Quality(85),
+...     ),
+...     format='webp',
+... )
+>>> url = client.url(
+...     'https://example.com/photo.jpg',
+...     transform=thumbnail,
+... )
+>>> url.startswith('https://images.example.com/unsafe/rs:fill:300:300/q:85/')
+True
+>>> url.endswith('.webp')
+True
+
+```
+
+Reuse `client` and `thumbnail` for other source images. Options you omit are
+left to imgproxy's defaults.
+
+Without signing credentials, URLs use the `unsafe` marker and require a server
+with signature checking disabled.
+
+### Signed URLs
+
+Supply the hex-encoded key and salt from your imgproxy server configuration:
+
+```python
+import os
+
+from imgproxykit import Client
+
+client = Client(
+    'https://images.example.com',
+    key=os.environ['IMGPROXY_KEY'],
+    salt=os.environ['IMGPROXY_SALT'],
+)
+
+url = client.url(
+    'https://example.com/photo.jpg',
+    transform=thumbnail,
+)
+```
+
+Both credentials are required together. The client signs each generated path
+automatically.
+
+### Server presets
+
+Already have presets on your imgproxy server? Reference them by name:
+
+```python
+url = client.url(
+    'https://example.com/photo.jpg',
+    presets=('thumbnail', 'watermarked'),
+    format='webp',
+)
+```
+
+Use either a Python `transform` or server `presets` in each call.
+For Python transforms, set `format` on `Transform`; for presets, pass it to
+`client.url()`.
+
+## Contributing
+
+See the [contributing guide](CONTRIBUTING.md) for development setup and checks.
+Bug reports and feature requests are welcome on the
+[issue tracker](https://github.com/kondratevdev/imgproxykit/issues).
+
+## License
+
+[MIT](LICENSE)
+
+## Credits
+
+Generated with
+[`wemake-python-package`](https://github.com/wemake-services/wemake-python-package)
+([template version](https://github.com/wemake-services/wemake-python-package/tree/47d9dddd29da8d6d3d1a403f8a143b323a812083)).
+

imgproxykit-0.1.0.dist-info/RECORD

@@ -0,0 +1,62 @@
+imgproxykit/__init__.py,sha256=pC8RvaQYaeT2-Ete16P8gnvmTH1Or-JEx0vjymXsvqw,105
+imgproxykit/builders.py,sha256=pW0iYMeQh4dZ3Z6A1ng5gjnV49TkMS-0lLiPSmMqMt0,4617
+imgproxykit/client.py,sha256=zNWZ6pftNCPmvy8o21NV51pRWMiVcfJlrPdSr1lZ6kc,5825
+imgproxykit/internal/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+imgproxykit/internal/constants.py,sha256=ixwWAgQZGmKpjL0017hVjFz8NMqKDP2cSoV7F8dCxNw,308
+imgproxykit/internal/empty.py,sha256=ZMHXhtB-NE3D5b8perf2VNobGfR3BN72VcAKbKyIStw,279
+imgproxykit/internal/encoding.py,sha256=uBO1gxNJf0u8L2OcgQL-hOGmOuSDgElQf7MEIK_vGxY,417
+imgproxykit/internal/paths.py,sha256=ksLWpxnjALhwPhWI8O0RirlBusNLtLdkFa8udpDU2hI,700
+imgproxykit/internal/serialization.py,sha256=6sihHCHPWR4zP2LAD7XUvKpduQVOqwlNbIf1M0U6H7I,1283
+imgproxykit/options/__init__.py,sha256=8mH1qM4uHOYinztvzlWPzmYbPKk0_QhHl9d2PIQSgdc,3049
+imgproxykit/options/auto_rotate.py,sha256=DywJWGGIQgkv0U6E0naXhZdNXDw5cK9b49ZN0cCi6A8,958
+imgproxykit/options/background.py,sha256=cEGpMC5TqjQX8oY00_qJG47mm0SB3knrAriojFt1A5U,1292
+imgproxykit/options/base.py,sha256=wkXztojelMLwJCwFd4l_ydDCbOkhWdP8Gv3w_O-W6l8,1252
+imgproxykit/options/blur.py,sha256=lo0VJKlQ26aabShIcYKR_8xgAhFu7BnK7wO1GGs3miA,821
+imgproxykit/options/cache_buster.py,sha256=wmIo0pBSQ_bIv1rsFg5hrS6Luc6h2rs77ArMF7KAj_0,1032
+imgproxykit/options/crop.py,sha256=pwd0ybItX8-JQLAqcOPqtasoboXFBTdftf7NdNPMDT0,1847
+imgproxykit/options/dpr.py,sha256=ZR-2fhYKXjE3irH6M-H51XsyU9IHTeviOfGDYHfIKvw,868
+imgproxykit/options/enforce_thumbnail.py,sha256=aDaL6r3cMxcCRcqVO1A8IXIe8Gm-_d0tTJR9XGx-oaU,969
+imgproxykit/options/enlarge.py,sha256=ppwkedl2NTrUzUw2vdzaGRmH9gFdQi68LtG3PC1wo08,873
+imgproxykit/options/expires.py,sha256=9Tx6b6W-C4t-ma62UQWu2KGfgR1AuiatrQXRSMcGooQ,894
+imgproxykit/options/extend.py,sha256=5zYhPoDPAKWZHWB6jRoWA0Z_da3eX-81d6fmXAK5j7U,1392
+imgproxykit/options/extend_aspect_ratio.py,sha256=H-0izMubhs0xW1wqk_IPhXx-xBbD4d3zQrBrQs6Y9RQ,1447
+imgproxykit/options/filename.py,sha256=5apkeX2cqwuKyne_5nuccXCTI9squP7XYSam6GbsKWw,1134
+imgproxykit/options/flip.py,sha256=7ahYVqIMRKrMRcW9lQ0MkQqsdCNV3oaws0ceZ9ny7RE,1129
+imgproxykit/options/format_quality.py,sha256=ebIO-7UVWNv5FGbW5xBkFcdPjIGA4SaYCGhn-WCSPZ8,1051
+imgproxykit/options/gravity.py,sha256=Ix67v-TgRMjei_RNAqK9v3sLg_h0o5v0QSJaP_B9EdE,1349
+imgproxykit/options/height.py,sha256=E-01ihdr30FmVeAWV3a1wf3R3B2F8jbbnih-scmspiA,890
+imgproxykit/options/keep_copyright.py,sha256=RS0Mp9grKf8GpzjwQkWjKHL-juNGRXvl7yhkvHqCkVQ,900
+imgproxykit/options/max_animation_frame_resolution.py,sha256=J7CqieF7iPZlePtHfP1Ygb6VgTkihMQ153rJk-F8vkg,1051
+imgproxykit/options/max_animation_frames.py,sha256=idcjEEpFHLA3P9thH_0auvyKk0MKEEh_x7HPWk-JLZE,1000
+imgproxykit/options/max_bytes.py,sha256=0Ll4JhjEBEWGtPVEroUr8UkMvWfsHPsR9vEo-wrBgkk,957
+imgproxykit/options/max_result_dimension.py,sha256=tTAPlC-ZI_ryUWmZO0vCarprh90MOCpLyiAQKaAtLtU,1012
+imgproxykit/options/max_src_file_size.py,sha256=DvuJ7jCF8R40WbybWCC1070aHqAmJXtsUA6-nGPR98U,992
+imgproxykit/options/max_src_resolution.py,sha256=jmnE5bsrTP732G5gVFsZc-6L5FlNMgyBOtf4TRjwYgA,996
+imgproxykit/options/min_height.py,sha256=cQjyPTgf3fii5Wp4JTaIfVbic0uGUaPahtUQQOkqX-A,867
+imgproxykit/options/min_width.py,sha256=gisEoyO6k1cq1qT3KSqSTeutV8Rt8Rifg5uwgpMVVpI,860
+imgproxykit/options/padding.py,sha256=tKzSdZWx_uouLS_1fM93fb7Rp9OXCKwzUK9xLI6hd9Q,1474
+imgproxykit/options/pixelate.py,sha256=L28cyJJhQO4pmrVvh9Rq_3mjr4LbQ-5CXlFaYR_-Nss,837
+imgproxykit/options/preserve_hdr.py,sha256=kQFo17y-BkfnAsLJvEft-gc_k7RqcBROQ31loAXtWA8,909
+imgproxykit/options/quality.py,sha256=A2zj36rul_bhinYQte5SFRwkVHqSX6qclu-cWolesKA,811
+imgproxykit/options/raw.py,sha256=yj90l-BcOMNPu4VFIGRnnsHOtC31dcHMVIjcy5JHbI8,895
+imgproxykit/options/resize.py,sha256=iXFYO68HAsMIe2EU9KHRR4odyYnOiIqONisdYhVh3Bo,1505
+imgproxykit/options/resizing_type.py,sha256=XOsSTXCVXof1ARrDatO-e1wSbuHdKTsJsEu2wH1BU3c,948
+imgproxykit/options/return_attachment.py,sha256=KkGrWS8Molbz2xkYZmBVKdKkfCB-6YjW4wISDQtj1rs,978
+imgproxykit/options/rotate.py,sha256=AdQdr1u3KtgWJaaO6PdJj-nMkEXBs2fEAgqGn-UDerw,881
+imgproxykit/options/sharpen.py,sha256=FagO74_OGq59yP5njfKjlZvfAFAlM4gkvPgKti-QrFs,831
+imgproxykit/options/size.py,sha256=SqvQx-PAHsqWprzuGDxC6-yGM0rJFK9_51UDXqL35eU,1259
+imgproxykit/options/skip_processing.py,sha256=M6bLjKOLEHxGERhhQO4eGqy3SwjNqtiIdnHPm4Z_gVQ,1054
+imgproxykit/options/strip_color_profile.py,sha256=DO2HWtrtOZxP9Qav-mZgGXmDtoMLfparRaoIbF7g3c0,1007
+imgproxykit/options/strip_metadata.py,sha256=JqBNCQRqAspUJdUPVVJx0Bx4ZXaYEFEnQL2pctJisos,887
+imgproxykit/options/trim.py,sha256=63zOwBE9R7FbxLUhQ-N0uwtoJ8eE00ZgxJjcmTsBxWo,1554
+imgproxykit/options/watermark.py,sha256=-DmoIFqidMGTSkBLhdn2uZvGi4aoWPzq9fvfnGRO3-Q,1820
+imgproxykit/options/width.py,sha256=0ApWI7dvDolilLYWIJUq9wFdMU9Hk1muja3gmyE4hec,883
+imgproxykit/options/zoom.py,sha256=wXAERiDFsj8YjgqVb9SqB2pYFNg-WPciO3uE4N5BrKc,1175
+imgproxykit/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+imgproxykit/signing.py,sha256=NXDMgBJ3nMa2vVQw8RcbZKI33b2EGHCN_87Ip_sAiBo,3506
+imgproxykit/transform.py,sha256=jQEzNhVDd_Qsv1q5Dj-me73vHrkxtKObOvJa7J7ELxM,1914
+imgproxykit/types.py,sha256=6bvlBxWwEcEjH0EWCcaXsMVuGJmpj9QgOvn0DWIEV-w,1152
+imgproxykit-0.1.0.dist-info/METADATA,sha256=A-3QXBSf0gSL3KKobdyWvVjKFi5JJ1GZqzhEkAPqtbQ,4401
+imgproxykit-0.1.0.dist-info/WHEEL,sha256=L-WvLdSBvJWHXv5zrQxDvNRnIgoBzLUpcbuiw19KCuQ,88
+imgproxykit-0.1.0.dist-info/licenses/LICENSE,sha256=DzvzsPqXVDlrI6vxhAAz4V9pipn3KwZ0kUCKb_2Fptk,1076
+imgproxykit-0.1.0.dist-info/RECORD,,

imgproxykit-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.5.0
+Root-Is-Purelib: true
+Tag: py3-none-any

imgproxykit-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alexander Kondratev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.