useknockout 0.2.0__tar.gz → 0.4.0__tar.gz

{useknockout-0.2.0 → useknockout-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: useknockout
-Version: 0.2.0
+Version: 0.4.0
 Summary: Python SDK for useknockout — state-of-the-art background removal API.
 Project-URL: Homepage, https://useknockout.com
 Project-URL: Documentation, https://github.com/useknockout/python
@@ -128,6 +128,7 @@ c.outline("photo.jpg", outline_color="#000000", outline_width=4)
 
 # Presets
 c.studio_shot("photo.jpg", aspect="1:1", shadow=True)  # e-commerce
+c.studio_shot("photo.jpg", transparent=True)           # transparent bg (PNG)
 c.headshot("photo.jpg", bg_color="#FFFFFF")            # LinkedIn 4:5 portrait
 c.headshot("photo.jpg", bg_blur=True, blur_radius=24)  # blurred original bg
 

{useknockout-0.2.0 → useknockout-0.4.0}/README.md

@@ -96,6 +96,7 @@ c.outline("photo.jpg", outline_color="#000000", outline_width=4)
 
 # Presets
 c.studio_shot("photo.jpg", aspect="1:1", shadow=True)  # e-commerce
+c.studio_shot("photo.jpg", transparent=True)           # transparent bg (PNG)
 c.headshot("photo.jpg", bg_color="#FFFFFF")            # LinkedIn 4:5 portrait
 c.headshot("photo.jpg", bg_blur=True, blur_radius=24)  # blurred original bg
 

{useknockout-0.2.0 → useknockout-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "useknockout"
-version = "0.2.0"
+version = "0.4.0"
 description = "Python SDK for useknockout — state-of-the-art background removal API."
 readme = "README.md"
 license = { text = "MIT" }

useknockout-0.4.0/src/useknockout/_version.py

@@ -0,0 +1 @@
+__version__ = "0.4.0"

{useknockout-0.2.0 → useknockout-0.4.0}/src/useknockout/async_client.py

@@ -65,9 +65,12 @@ class AsyncKnockout:
         files=None,
         data=None,
         json=None,
+        params=None,
     ) -> bytes:
         try:
-            r = await self._http.request(method, path, files=files, data=data, json=json)
+            r = await self._http.request(
+                method, path, files=files, data=data, json=json, params=params
+            )
         except httpx.RequestError as e:
             raise KnockoutError(f"network error: {e}", code="unknown") from e
         if r.status_code >= 400:
@@ -82,9 +85,12 @@ class AsyncKnockout:
         files=None,
         data=None,
         json=None,
+        params=None,
     ) -> Any:
         try:
-            r = await self._http.request(method, path, files=files, data=data, json=json)
+            r = await self._http.request(
+                method, path, files=files, data=data, json=json, params=params
+            )
         except httpx.RequestError as e:
             raise KnockoutError(f"network error: {e}", code="unknown") from e
         if r.status_code >= 400:
@@ -101,11 +107,12 @@ class AsyncKnockout:
         return await self._request_json("GET", "/stats")
 
     async def remove(self, file: FileInput, *, format: str = "png") -> bytes:
+        # /remove reads `format` as a QUERY param (bare default in the API).
         return await self._request_bytes(
             "POST",
             "/remove",
             files=_multipart_files(file),
-            data=_form({"format": format}),
+            params={"format": format},
         )
 
     async def remove_url(self, url: str, *, format: str = "png") -> bytes:
@@ -138,11 +145,12 @@ class AsyncKnockout:
     ) -> Dict[str, Any]:
         if len(files) > 10:
             raise ValueError("max 10 files per batch")
+        # /remove-batch reads `format` as a QUERY param (bare default in the API).
         return await self._request_json(
             "POST",
             "/remove-batch",
             files=_multipart_batch(files),
-            data=_form({"format": format}),
+            params={"format": format},
         )
 
     async def remove_batch_url(self, urls: List[str], *, format: str = "png") -> Dict[str, Any]:
@@ -250,6 +258,7 @@ class AsyncKnockout:
         aspect: str = "1:1",
         padding: int = 48,
         shadow: bool = True,
+        transparent: bool = False,
         format: str = "jpg",
     ) -> bytes:
         return await self._request_bytes(
@@ -262,6 +271,7 @@ class AsyncKnockout:
                     "aspect": aspect,
                     "padding": padding,
                     "shadow": shadow,
+                    "transparent": transparent,
                     "format": format,
                 }
             ),
@@ -355,13 +365,20 @@ class AsyncKnockout:
         file: FileInput,
         *,
         only_center_face: bool = False,
+        bg_enhance: bool = False,
         format: str = "png",
     ) -> bytes:
         return await self._request_bytes(
             "POST",
             "/face-restore",
             files=_multipart_files(file),
-            data=_form({"only_center_face": only_center_face, "format": format}),
+            data=_form(
+                {
+                    "only_center_face": only_center_face,
+                    "bg_enhance": bg_enhance,
+                    "format": format,
+                }
+            ),
         )
 
     async def colorize(

{useknockout-0.2.0 → useknockout-0.4.0}/src/useknockout/client.py

@@ -75,9 +75,12 @@ class Knockout:
         files=None,
         data=None,
         json=None,
+        params=None,
     ) -> bytes:
         try:
-            r = self._http.request(method, path, files=files, data=data, json=json)
+            r = self._http.request(
+                method, path, files=files, data=data, json=json, params=params
+            )
         except httpx.RequestError as e:
             raise KnockoutError(f"network error: {e}", code="unknown") from e
         if r.status_code >= 400:
@@ -92,9 +95,12 @@ class Knockout:
         files=None,
         data=None,
         json=None,
+        params=None,
     ) -> Any:
         try:
-            r = self._http.request(method, path, files=files, data=data, json=json)
+            r = self._http.request(
+                method, path, files=files, data=data, json=json, params=params
+            )
         except httpx.RequestError as e:
             raise KnockoutError(f"network error: {e}", code="unknown") from e
         if r.status_code >= 400:
@@ -116,11 +122,13 @@ class Knockout:
 
     def remove(self, file: FileInput, *, format: str = "png") -> bytes:
         """POST /remove — remove background, return transparent PNG/WebP bytes."""
+        # /remove reads `format` as a QUERY param (bare default in the API), unlike
+        # the Form()-based endpoints. Sending it in the body would be ignored.
         return self._request_bytes(
             "POST",
             "/remove",
             files=_multipart_files(file),
-            data=_form({"format": format}),
+            params={"format": format},
         )
 
     def remove_url(self, url: str, *, format: str = "png") -> bytes:
@@ -156,11 +164,12 @@ class Knockout:
         """POST /remove-batch — up to 10 multipart uploads in one call."""
         if len(files) > 10:
             raise ValueError("max 10 files per batch")
+        # /remove-batch reads `format` as a QUERY param (bare default in the API).
         return self._request_json(
             "POST",
             "/remove-batch",
             files=_multipart_batch(files),
-            data=_form({"format": format}),
+            params={"format": format},
         )
 
     def remove_batch_url(self, urls: List[str], *, format: str = "png") -> Dict[str, Any]:
@@ -274,9 +283,14 @@ class Knockout:
         aspect: str = "1:1",
         padding: int = 48,
         shadow: bool = True,
+        transparent: bool = False,
         format: str = "jpg",
     ) -> bytes:
-        """POST /studio-shot — e-commerce preset (cutout + crop + center + shadow)."""
+        """POST /studio-shot — e-commerce preset (cutout + crop + center + shadow).
+
+        Set ``transparent=True`` to keep a transparent background (bg_color and
+        shadow are ignored; output is PNG, jpg is coerced).
+        """
         return self._request_bytes(
             "POST",
             "/studio-shot",
@@ -287,6 +301,7 @@ class Knockout:
                     "aspect": aspect,
                     "padding": padding,
                     "shadow": shadow,
+                    "transparent": transparent,
                     "format": format,
                 }
             ),
@@ -390,11 +405,13 @@ class Knockout:
         file: FileInput,
         *,
         only_center_face: bool = False,
+        bg_enhance: bool = False,
         format: str = "png",
     ) -> bytes:
         """POST /face-restore — GFPGAN v1.4 portrait restoration.
 
-        Fixes blurry / damaged / low-res faces; background is 2x upscaled by
+        Fixes blurry / damaged / low-res faces. By default the background is
+        preserved as-is. ``bg_enhance=True`` also upscales the background 2x via
         Real-ESRGAN. ``only_center_face=True`` restores just the most prominent
         face (faster).
         """
@@ -402,7 +419,13 @@ class Knockout:
             "POST",
             "/face-restore",
             files=_multipart_files(file),
-            data=_form({"only_center_face": only_center_face, "format": format}),
+            data=_form(
+                {
+                    "only_center_face": only_center_face,
+                    "bg_enhance": bg_enhance,
+                    "format": format,
+                }
+            ),
         )
 
     def colorize(

useknockout-0.2.0/src/useknockout/_version.py

@@ -1 +0,0 @@
-__version__ = "0.2.0"