django-imgproxy 0.1.0__py3-none-any.whl

django_imgproxy/__init__.py

@@ -0,0 +1,4 @@
+__all__ = ["imgproxy", "ImgProxyImageField"]
+
+from .builder import imgproxy
+from .fields import ImgProxyImageField

django_imgproxy/builder.py

@@ -0,0 +1,60 @@
+__all__ = ["imgproxy"]
+
+import base64
+import hashlib
+import hmac
+import urllib.parse
+
+from django_imgproxy import settings
+
+
+def imgproxy(
+    source_url: str,
+    extension: str | None = None,
+    b64_filename: str | None = None,
+    **kwargs,
+) -> str:
+    source_url = settings.IMGPROXY_SOURCE_URL_PREFIX + source_url
+    if settings.IMGPROXY_BASE64_ENCODE_SOURCE_URL:
+        source_url = base64.urlsafe_b64encode(source_url.encode()).rstrip(b"=").decode()
+
+        if b64_filename:
+            source_url += "/" + urllib.parse.quote(b64_filename)
+    else:
+        source_url = urllib.parse.quote(
+            source_url,
+            safe=settings.IMGPROXY_PERCENT_ENCODE_SOURCE_URL_SAFE_CHARACTERS,
+        )
+        if extension:
+            source_url += "@" + extension
+        source_url = "plain/" + source_url
+
+    processing_options = []
+    if settings.IMGPROXY_ONLY_PRESETS:
+        if presets := kwargs.get("preset", kwargs.get("pr")):
+            processing_options.append(
+                presets if isinstance(presets, str) else str(presets)
+            )
+    else:
+        for option, arguments in kwargs.items():
+            if option in settings.IMGPROXY_PERCENT_ENCODED_PROCESSING_OPTIONS:
+                arguments = urllib.parse.quote(arguments, safe="")
+
+            processing_options.append(
+                "%s%s%s" % (option, settings.IMGPROXY_ARGUMENTS_SEPARATOR, arguments)
+            )
+
+    path = "/%s/%s" % ("/".join(processing_options), source_url)
+
+    if settings.IMGPROXY_SIGN_URL:
+        digest = hmac.digest(
+            key=settings.IMGPROXY_KEY,
+            msg=settings.IMGPROXY_SALT + path.encode(),
+            digest=hashlib.sha256,
+        )
+        signature = base64.urlsafe_b64encode(digest).rstrip(b"=").decode()
+    else:
+        signature = settings.IMGPROXY_NO_SIGNATURE_SEGMENT
+
+    image_url = "%s/%s%s" % (settings.IMGPROXY_BASE_URL, signature, path)
+    return image_url

django_imgproxy/fields.py

@@ -0,0 +1,26 @@
+__all__ = ["ImgProxyImageFieldFile", "ImgProxyImageField"]
+
+from datetime import timedelta
+
+from django.db.models.fields.files import ImageField, ImageFieldFile
+from django.utils import timezone
+
+from django_imgproxy import imgproxy, settings
+
+
+class ImgProxyImageFieldFile(ImageFieldFile):
+    @property
+    def url(self) -> str:
+        self._require_file()
+
+        processing_options = {"raw": "true"}
+        if ttl := settings.IMGPROXY_IMAGEFIELD_URL_TTL:
+            processing_options["expires"] = int(
+                (timezone.now() + timedelta(seconds=ttl)).timestamp()
+            )
+
+        return imgproxy(self.name, **processing_options)
+
+
+class ImgProxyImageField(ImageField):
+    attr_class = ImgProxyImageFieldFile

django_imgproxy/settings.py

@@ -0,0 +1,25 @@
+from django.conf import settings
+
+IMGPROXY_BASE_URL = getattr(
+    settings, "IMGPROXY_BASE_URL", "http://localhost:8080"
+).rstrip("/")
+IMGPROXY_ONLY_PRESETS = getattr(settings, "IMGPROXY_ONLY_PRESETS", False)
+IMGPROXY_ARGUMENTS_SEPARATOR = getattr(settings, "IMGPROXY_ARGUMENTS_SEPARATOR", ":")
+IMGPROXY_KEY = bytes.fromhex(getattr(settings, "IMGPROXY_KEY", ""))
+IMGPROXY_SALT = bytes.fromhex(getattr(settings, "IMGPROXY_SALT", ""))
+IMGPROXY_SIGN_URL = bool(IMGPROXY_KEY) and bool(IMGPROXY_SALT)
+IMGPROXY_NO_SIGNATURE_SEGMENT = getattr(
+    settings, "IMGPROXY_NO_SIGNATURE_SEGMENT", "unsafe"
+)
+IMGPROXY_PERCENT_ENCODED_PROCESSING_OPTIONS = getattr(
+    settings, "IMGPROXY_PERCENT_ENCODED_PROCESSING_OPTIONS", {"filename", "fn"}
+)
+IMGPROXY_SOURCE_URL_PREFIX = getattr(settings, "IMGPROXY_SOURCE_URL_PREFIX", "")
+IMGPROXY_PERCENT_ENCODE_SOURCE_URL = getattr(
+    settings, "IMGPROXY_PERCENT_ENCODE_SOURCE_URL", True
+)
+IMGPROXY_PERCENT_ENCODE_SOURCE_URL_SAFE_CHARACTERS = "/"
+IMGPROXY_BASE64_ENCODE_SOURCE_URL = getattr(
+    settings, "IMGPROXY_BASE64_ENCODE_SOURCE_URL", False
+)
+IMGPROXY_IMAGEFIELD_URL_TTL = getattr(settings, "IMGPROXY_IMAGEFIELD_URL_TTL", 0)

django_imgproxy/templatetags/imgproxy.py

@@ -0,0 +1,6 @@
+from django import template
+
+from django_imgproxy import imgproxy
+
+register = template.Library()
+register.simple_tag(imgproxy)

django_imgproxy-0.1.0.dist-info/METADATA

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: django-imgproxy
+Version: 0.1.0
+Summary: Build imgproxy URLs for your Django templates
+Keywords: django,imgproxy
+Author: anime.com.br
+Author-email: anime.com.br <opensource@anime.com.br>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 6
+Classifier: Framework :: Django :: 6.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved
+Classifier: License :: OSI Approved :: MIT License
+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: Topic :: Internet
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: django>=6.0
+Requires-Python: >=3.12
+Project-URL: Source, https://github.com/animebr/django-imgproxy
+Project-URL: Discord, https://anime.com.br/discord
+Description-Content-Type: text/markdown
+

django_imgproxy-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+django_imgproxy/__init__.py,sha256=kxxRbLQPtBsir8IrFtT3mHIdAOHZqkOW1XTosC0BKSU,115
+django_imgproxy/builder.py,sha256=pMoLYW8mSoYFMt0X2lrMHqVMomOWtItouFItblNSpck,1932
+django_imgproxy/fields.py,sha256=DxPtXhfmnh_4PSF0zkUaIWW9iVxGv5u2fz0Wo2pn4dQ,733
+django_imgproxy/settings.py,sha256=0qy_L6H8zhPCyVYscB0BG-AdebhqioXjdnAuP0PiRTE,1162
+django_imgproxy/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_imgproxy/templatetags/imgproxy.py,sha256=yb0IVGrDeqSC44MZHqrfvbg9KqeahI3hWowBPgtxzeo,127
+django_imgproxy-0.1.0.dist-info/licenses/LICENSE,sha256=bDpT2BwiyH3OMuYXftT10YpU5rbA3oUz6N_o9--Se2w,1069
+django_imgproxy-0.1.0.dist-info/WHEEL,sha256=8ZlpUMJ7mlDirmlHRhDirEx_nPnARrwDjeE92mlk68E,81
+django_imgproxy-0.1.0.dist-info/METADATA,sha256=oehz1mvXe2WH6_doT1v18qQQx_esgrfwM94VCyWU6-g,1329
+django_imgproxy-0.1.0.dist-info/RECORD,,

django_imgproxy-0.1.0.dist-info/WHEEL

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

django_imgproxy-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 anime.com.br
+
+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.