Merge pull request #62 from imagekit-developer/SDK-94

added effect_shadow and effect_gradient parameter

Author: imagekitio

.github/workflows/publish.yml

@@ -2,7 +2,7 @@ name: Upload Python Package
 
 on:
   release:
-    types: [created]
+    types: [published]
 
 jobs:
   deploy:

README.md

@@ -57,6 +57,14 @@ This document presents a list of changes that break the existing functionality o
 
 ### Breaking History:
 
+Changes from `3.2.0 -> 4.0.0` are listed below
+
+1. Overlay syntax update
+
+* In version 4.0.0, we've removed the old overlay syntax parameters for transformations, such as `oi`, `ot`, `obg`, and [more](https://docs.imagekit.io/features/image-transformations/overlay). These parameters are deprecated and will start returning errors when used in URLs. Please migrate to the new layers syntax that supports overlay nesting, provides better positional control, and allows more transformations at the layer level. You can start with [examples](https://docs.imagekit.io/features/image-transformations/overlay-using-layers#examples) to learn quickly.
+* You can migrate to the new layers syntax using the `raw` transformation parameter.
+
+
 Changes from `2.2.8 -> 3.0.0` are listed below
 
 1. Throw an Error:
@@ -292,6 +300,29 @@ image_url = imagekit.url({
 https://ik.imagekit.io/your_imagekit_id/tr:h-300,w-400,l-image,i-ik_canvas,bg-FF0000,w-300,h-100,l-end/img/sample-video.mp4
 ```
 
+**5. Arithmetic expressions in transformations**
+
+ImageKit allows use of [arithmetic expressions](https://docs.imagekit.io/features/arithmetic-expressions-in-transformations) in certain dimension and position-related parameters, making media transformations more flexible and dynamic.
+
+For example:
+
+```python
+image_url = imagekit.url({
+    "path": "/default-image.jpg",
+    "url_endpoint": "https://ik.imagekit.io/your_imagekit_id/endpoint/",
+    "transformation": [{
+        "height": "ih_div_2",
+        "width": "iw_div_4",
+        "border": "cw_mul_0.05_yellow"
+    }],
+})
+```
+
+**Sample Result URL**
+```
+https://ik.imagekit.io/your_imagekit_id/default-image.jpg?tr=w-iw_div_4,h-ih_div_2,b-cw_mul_0.05_yellow
+```
+
 **List of transformations**
 
 The complete list of transformations supported and their usage in ImageKit is available [here](https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations).
@@ -328,6 +359,8 @@ If you want to generate transformations in your application and add them to the
 | effect_usm                    | e-usm                           |
 | effect_contrast               | e-contrast                      |
 | effect_gray                   | e-grayscale                     |
+| effect_shadow                 | e-shadow                        |
+| effect_gradient               | e-gradient                      |
 | original                      | orig                            |
 | raw                           | replaced by the parameter value |
 
@@ -363,6 +396,16 @@ extensions = [
     }
 ]
 
+transformation = {
+    'pre': 'l-text,i-Imagekit,fs-50,l-end', 
+    'post': [
+        {
+            'type': 'transformation', 
+            'value': 'w-100'
+        }
+    ]
+}
+
 options = UploadFileRequestOptions(
     use_unique_file_name=False,
     tags=['abc', 'def'],
@@ -378,6 +421,7 @@ options = UploadFileRequestOptions(
     overwrite_tags=False,
     overwrite_custom_metadata=True,
     custom_metadata={'testss': 12},
+    transformation=transformation
 )
 
 result = imagekit.upload_file(file='<url|base_64|binary>', # required

imagekitio/constants/files.py

@@ -29,4 +29,5 @@
     "overwrite_custom_metadata",
     "custom_metadata",
     "embedded_metadata",
+    "transformation",
 ]

imagekitio/constants/supported_transform.py

@@ -15,34 +15,6 @@
     "rotation": "rt",
     "blur": "bl",
     "named": "n",
-    "overlay_x": "ox",
-    "overlay_y": "oy",
-    "overlay_focus": "ofo",
-    "overlay_height": "oh",
-    "overlay_width": "ow",
-    "overlay_image": "oi",
-    "overlay_image_trim": "oit",
-    "overlay_image_aspect_ratio": "oiar",
-    "overlay_image_background": "oibg",
-    "overlay_image_border": "oib",
-    "overlay_image_dpr": "oidpr",
-    "overlay_image_quality": "oiq",
-    "overlay_image_cropping": "oic",
-    "overlay_image_focus": "oifo",
-    "overlay_text": "ot",
-    "overlay_text_font_size": "ots",
-    "overlay_text_font_family": "otf",
-    "overlay_text_color": "otc",
-    "overlay_text_transparency": "oa",
-    "overlay_alpha": "oa",
-    "overlay_text_typography": "ott",
-    "overlay_background": "obg",
-    "overlay_text_encoded": "ote",
-    "overlay_text_width": "otw",
-    "overlay_text_background": "otbg",
-    "overlay_text_padding": "otp",
-    "overlay_text_inner_alignment": "otia",
-    "overlay_radius": "or",
     "progressive": "pr",
     "lossless": "lo",
     "trim": "t",
@@ -54,6 +26,8 @@
     "effect_usm": "e-usm",
     "effect_contrast": "e-contrast",
     "effect_gray": "e-grayscale",
+    'effect_shadow': "e-shadow",
+    'effect_gradient': "e-gradient",
     "original": "orig",
     "raw": "raw",
 }

imagekitio/models/UploadFileRequestOptions.py

@@ -18,6 +18,7 @@ def __init__(
         overwrite_tags: bool = None,
         overwrite_custom_metadata: bool = None,
         custom_metadata: json = None,
+        transformation: json = None,
     ):
         if use_unique_file_name is not None:
             self.use_unique_file_name = use_unique_file_name
@@ -45,3 +46,5 @@ def __init__(
             self.overwrite_custom_metadata = overwrite_custom_metadata
         if custom_metadata is not None:
             self.custom_metadata = custom_metadata
+        if transformation is not None:
+            self.transformation = transformation

setup.py

@@ -8,7 +8,7 @@
 
 setuptools.setup(
     name="imagekitio",
-    version="3.2.0",
+    version="4.0.0",
     description="Python wrapper for the ImageKit API",
     long_description=long_description,
     long_description_content_type="text/markdown",

tests/test_files_ops.py

@@ -364,32 +364,6 @@ def test_generate_url_with_all_params(self):
                     "rotation": 90,
                     "blur": 10,
                     "named": "some_name",
-                    "overlay_image": "/folder/file.jpg",  # leading slash case
-                    "overlay_image_aspect_ratio": "4:3",
-                    "overlay_image_background": "0F0F0F",
-                    "overlay_image_border": "10_0F0F0F",
-                    "overlay_image_dpr": 2,
-                    "overlay_image_quality": 50,
-                    "overlay_image_cropping": "force",
-                    "overlay_image_trim": False,
-                    "overlay_x": 35,
-                    "overlay_y": 35,
-                    "overlay_focus": "bottom",
-                    "overlay_height": 20,
-                    "overlay_width": 20,
-                    "overlay_text": "two words",
-                    "overlay_text_font_size": 20,
-                    "overlay_text_font_family": "Open Sans",
-                    "overlay_text_color": "00FFFF",
-                    "overlay_text_transparency": 5,
-                    "overlay_text_typography": "b",
-                    "overlay_background": "00AAFF55",
-                    "overlay_text_encoded": "b3ZlcmxheSBtYWRlIGVhc3k%3D",
-                    "overlay_text_width": 50,
-                    "overlay_text_background": "00AAFF55",
-                    "overlay_text_padding": 40,
-                    "overlay_text_inner_alignment": "left",
-                    "overlay_radius": 10,
                     "progressive": "true",
                     "lossless": "true",
                     "trim": 5,
@@ -401,6 +375,8 @@ def test_generate_url_with_all_params(self):
                     "effect_usm": "2-2-0.8-0.024",
                     "effect_contrast": "true",
                     "effect_gray": "true",
+                    "effect_shadow": "bl-15_st-40_x-10_y-N5",
+                    "effect_gradient": "from-red_to-white",
                     "original": True,  # Boolean handling
                     "raw": "w-200,h-200",
                 }
@@ -410,11 +386,8 @@ def test_generate_url_with_all_params(self):
         self.assertEqual(
             url,
             "https://test-domain.com/test-endpoint/tr:h-300,w-400,ar-4-3,q-40,c-force,cm-extract,fo-left,f-jpeg,r-50,"
-            "bg-A94D34,b-5-A94D34,rt-90,bl-10,n-some_name,oi-folder@@file.jpg,oiar-4:3,oibg-0F0F0F,oib-10_0F0F0F,"
-            "oidpr-2,oiq-50,oic-force,oit-false,ox-35,oy-35,ofo-bottom,oh-20,ow-20,ot-two words,ots-20,otf-Open Sans,"
-            "otc-00FFFF,oa-5,ott-b,obg-00AAFF55,ote-b3ZlcmxheSBtYWRlIGVhc3k%3D,otw-50,otbg-00AAFF55,otp-40,otia-left,"
-            "or-10,pr-true,lo-true,t-5,md-true,cp-true,di-folder@@file.jpg,dpr-3,e-sharpen-10,e-usm-2-2-0.8-0.024,"
-            "e-contrast-true,e-grayscale-true,orig-true,w-200,h-200/test_path.jpg",
+            "bg-A94D34,b-5-A94D34,rt-90,bl-10,n-some_name,pr-true,lo-true,t-5,md-true,cp-true,di-folder@@file.jpg,dpr-3,e-sharpen-10,e-usm-2-2-0.8-0.024,"
+            "e-contrast-true,e-grayscale-true,e-shadow-bl-15_st-40_x-10_y-N5,e-gradient-from-red_to-white,orig-true,w-200,h-200/test_path.jpg",
         )
 
     def test_get_signature_with_100_expire_seconds(self):