useknockout 0.0.2__tar.gz → 0.0.4__tar.gz

{useknockout-0.0.2 → useknockout-0.0.4}/.gitignore

@@ -1,32 +1,32 @@
-# Python
-__pycache__/
-*.py[cod]
-*$py.class
-*.egg-info/
-*.egg
-build/
-dist/
-.eggs/
-.venv/
-venv/
-env/
-.python-version
-
-# Tests / coverage
-.pytest_cache/
-.coverage
-htmlcov/
-.mypy_cache/
-.ruff_cache/
-
-# IDE
-.vscode/
-.idea/
-*.swp
-.DS_Store
-
-# Demo outputs
-out-*.png
-out-*.jpg
-demo-*.png
-demo-*.jpg
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+*.egg
+build/
+dist/
+.eggs/
+.venv/
+venv/
+env/
+.python-version
+
+# Tests / coverage
+.pytest_cache/
+.coverage
+htmlcov/
+.mypy_cache/
+.ruff_cache/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+.DS_Store
+
+# Demo outputs
+out-*.png
+out-*.jpg
+demo-*.png
+demo-*.jpg

{useknockout-0.0.2 → useknockout-0.0.4}/LICENSE

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

{useknockout-0.0.2 → useknockout-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: useknockout
-Version: 0.0.2
+Version: 0.0.4
 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

{useknockout-0.0.2 → useknockout-0.0.4}/README.md

@@ -1,159 +1,159 @@
-<div align="center">
-
-# 🥊 useknockout
-
-**State-of-the-art background removal API — Python SDK.**
-
-[![PyPI](https://img.shields.io/pypi/v/useknockout.svg)](https://pypi.org/project/useknockout/)
-[![Python](https://img.shields.io/pypi/pyversions/useknockout.svg)](https://pypi.org/project/useknockout/)
-[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
-
-[Website](https://useknockout.com) ·
-[API repo](https://github.com/useknockout/api) ·
-[Node SDK](https://github.com/useknockout/node) ·
-[React SDK](https://github.com/useknockout/react) ·
-[CLI](https://github.com/useknockout/cli)
-
-<img src="https://raw.githubusercontent.com/useknockout/api/main/docs/banner.png" width="800" alt="useknockout — background removal API for developers" />
-
-*Background removal, 40× cheaper than remove.bg. MIT licensed. Self-hostable.*
-
-</div>
-
----
-
-## Install
-
-```bash
-pip install useknockout
-```
-
-## Quickstart
-
-```python
-from useknockout import Knockout
-
-client = Knockout()  # uses public beta token by default
-png = client.remove("photo.jpg")
-
-with open("out.png", "wb") as f:
-    f.write(png)
-```
-
-That's it. Free during the public beta.
-
-## Async
-
-```python
-import asyncio
-from useknockout import AsyncKnockout
-
-async def main():
-    async with AsyncKnockout() as client:
-        png = await client.remove("photo.jpg")
-        open("out.png", "wb").write(png)
-
-asyncio.run(main())
-```
-
-## Authentication
-
-The client falls back through three sources in order:
-
-1. The `token=` argument
-2. The `KNOCKOUT_TOKEN` environment variable
-3. The public beta token (free, rate-limited, in the README of the API repo)
-
-Get your own token by emailing `troy@useknockout.com` (paid tier launches at $0.005/image — 40× cheaper than remove.bg).
-
-## All endpoints
-
-```python
-from useknockout import Knockout
-
-c = Knockout()
-
-# Remove background
-c.remove("photo.jpg")                                  # returns PNG bytes
-c.remove_url("https://example.com/photo.jpg")
-c.remove_batch(["a.jpg", "b.jpg", "c.jpg"])            # up to 10
-c.remove_batch_url(["https://...", "https://..."])
-
-# Replace background
-c.replace_background("photo.jpg", bg_color="#000000")
-c.replace_background("photo.jpg", bg_url="https://example.com/bg.jpg")
-
-# Mask only
-c.mask("photo.jpg")                                    # returns grayscale PNG
-
-# Crop to subject
-c.smart_crop("photo.jpg", padding=24)
-
-# Effects
-c.shadow("photo.jpg", shadow_blur=14, shadow_opacity=0.45)
-c.sticker("photo.jpg", stroke_width=20)                # WhatsApp-style
-c.outline("photo.jpg", outline_color="#000000", outline_width=4)
-
-# Presets
-c.studio_shot("photo.jpg", aspect="1:1", shadow=True)  # e-commerce
-c.headshot("photo.jpg", bg_color="#FFFFFF")            # LinkedIn 4:5 portrait
-c.headshot("photo.jpg", bg_blur=True, blur_radius=24)  # blurred original bg
-
-# Marketing
-c.compare("photo.jpg")                                 # before/after side-by-side
-
-# UX helpers
-c.preview("photo.jpg", max_dim=512)                    # ~80ms warm
-c.estimate("remove", width=1024, height=1024)          # predict latency + cost
-
-# Telemetry
-c.health()
-c.stats()                                              # public usage counter
-```
-
-Every method that returns an image returns raw bytes. Pipe to `open(path, "wb").write(...)`, `BytesIO`, `PIL.Image.open(BytesIO(...))`, `numpy`, S3 — anywhere bytes go.
-
-## Errors
-
-All errors inherit from `KnockoutError`:
-
-```python
-from useknockout import Knockout
-from useknockout.errors import (
-    AuthError,           # 401 / 403
-    BadRequestError,     # 400
-    PayloadTooLargeError,# 413 (>25 MB)
-    RateLimitError,      # 429
-    ServerError,         # 5xx
-    KnockoutError,       # base class / network errors
-)
-
-try:
-    png = client.remove("photo.jpg")
-except AuthError:
-    ...  # bad token
-except RateLimitError:
-    ...  # back off
-except KnockoutError as e:
-    print(f"{e.code} ({e.status}): {e.message}")
-```
-
-## Self-host
-
-The API is open source and runs on Modal. Deploy your own copy:
-
-```bash
-git clone https://github.com/useknockout/api
-cd api
-modal deploy main.py
-```
-
-Then point the SDK at your deployment:
-
-```python
-client = Knockout(token="your-token", base_url="https://your-deploy.modal.run")
-```
-
-## License
-
-MIT. Use it however you want.
+<div align="center">
+
+# 🥊 useknockout
+
+**State-of-the-art background removal API — Python SDK.**
+
+[![PyPI](https://img.shields.io/pypi/v/useknockout.svg)](https://pypi.org/project/useknockout/)
+[![Python](https://img.shields.io/pypi/pyversions/useknockout.svg)](https://pypi.org/project/useknockout/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+[Website](https://useknockout.com) ·
+[API repo](https://github.com/useknockout/api) ·
+[Node SDK](https://github.com/useknockout/node) ·
+[React SDK](https://github.com/useknockout/react) ·
+[CLI](https://github.com/useknockout/cli)
+
+<img src="https://raw.githubusercontent.com/useknockout/api/main/docs/banner.png" width="800" alt="useknockout — background removal API for developers" />
+
+*Background removal, 40× cheaper than remove.bg. MIT licensed. Self-hostable.*
+
+</div>
+
+---
+
+## Install
+
+```bash
+pip install useknockout
+```
+
+## Quickstart
+
+```python
+from useknockout import Knockout
+
+client = Knockout()  # uses public beta token by default
+png = client.remove("photo.jpg")
+
+with open("out.png", "wb") as f:
+    f.write(png)
+```
+
+That's it. Free during the public beta.
+
+## Async
+
+```python
+import asyncio
+from useknockout import AsyncKnockout
+
+async def main():
+    async with AsyncKnockout() as client:
+        png = await client.remove("photo.jpg")
+        open("out.png", "wb").write(png)
+
+asyncio.run(main())
+```
+
+## Authentication
+
+The client falls back through three sources in order:
+
+1. The `token=` argument
+2. The `KNOCKOUT_TOKEN` environment variable
+3. The public beta token (free, rate-limited, in the README of the API repo)
+
+Get your own token by emailing `troy@useknockout.com` (paid tier launches at $0.005/image — 40× cheaper than remove.bg).
+
+## All endpoints
+
+```python
+from useknockout import Knockout
+
+c = Knockout()
+
+# Remove background
+c.remove("photo.jpg")                                  # returns PNG bytes
+c.remove_url("https://example.com/photo.jpg")
+c.remove_batch(["a.jpg", "b.jpg", "c.jpg"])            # up to 10
+c.remove_batch_url(["https://...", "https://..."])
+
+# Replace background
+c.replace_background("photo.jpg", bg_color="#000000")
+c.replace_background("photo.jpg", bg_url="https://example.com/bg.jpg")
+
+# Mask only
+c.mask("photo.jpg")                                    # returns grayscale PNG
+
+# Crop to subject
+c.smart_crop("photo.jpg", padding=24)
+
+# Effects
+c.shadow("photo.jpg", shadow_blur=14, shadow_opacity=0.45)
+c.sticker("photo.jpg", stroke_width=20)                # WhatsApp-style
+c.outline("photo.jpg", outline_color="#000000", outline_width=4)
+
+# Presets
+c.studio_shot("photo.jpg", aspect="1:1", shadow=True)  # e-commerce
+c.headshot("photo.jpg", bg_color="#FFFFFF")            # LinkedIn 4:5 portrait
+c.headshot("photo.jpg", bg_blur=True, blur_radius=24)  # blurred original bg
+
+# Marketing
+c.compare("photo.jpg")                                 # before/after side-by-side
+
+# UX helpers
+c.preview("photo.jpg", max_dim=512)                    # ~80ms warm
+c.estimate("remove", width=1024, height=1024)          # predict latency + cost
+
+# Telemetry
+c.health()
+c.stats()                                              # public usage counter
+```
+
+Every method that returns an image returns raw bytes. Pipe to `open(path, "wb").write(...)`, `BytesIO`, `PIL.Image.open(BytesIO(...))`, `numpy`, S3 — anywhere bytes go.
+
+## Errors
+
+All errors inherit from `KnockoutError`:
+
+```python
+from useknockout import Knockout
+from useknockout.errors import (
+    AuthError,           # 401 / 403
+    BadRequestError,     # 400
+    PayloadTooLargeError,# 413 (>25 MB)
+    RateLimitError,      # 429
+    ServerError,         # 5xx
+    KnockoutError,       # base class / network errors
+)
+
+try:
+    png = client.remove("photo.jpg")
+except AuthError:
+    ...  # bad token
+except RateLimitError:
+    ...  # back off
+except KnockoutError as e:
+    print(f"{e.code} ({e.status}): {e.message}")
+```
+
+## Self-host
+
+The API is open source and runs on Modal. Deploy your own copy:
+
+```bash
+git clone https://github.com/useknockout/api
+cd api
+modal deploy main.py
+```
+
+Then point the SDK at your deployment:
+
+```python
+client = Knockout(token="your-token", base_url="https://your-deploy.modal.run")
+```
+
+## License
+
+MIT. Use it however you want.

{useknockout-0.0.2 → useknockout-0.0.4}/pyproject.toml

@@ -1,60 +1,60 @@
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-[project]
-name = "useknockout"
-version = "0.0.2"
-description = "Python SDK for useknockout — state-of-the-art background removal API."
-readme = "README.md"
-license = { text = "MIT" }
-requires-python = ">=3.9"
-authors = [{ name = "useknockout" }]
-keywords = [
-    "background-removal",
-    "remove-background",
-    "birefnet",
-    "ai",
-    "image-processing",
-    "useknockout",
-]
-classifiers = [
-    "Development Status :: 4 - Beta",
-    "Intended Audience :: Developers",
-    "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: 3.13",
-    "Topic :: Multimedia :: Graphics",
-    "Topic :: Scientific/Engineering :: Image Processing",
-]
-dependencies = [
-    "httpx>=0.27.0",
-]
-
-[project.optional-dependencies]
-dev = [
-    "pytest>=8.0",
-    "pytest-asyncio>=0.23",
-    "ruff>=0.6.0",
-    "mypy>=1.10",
-]
-
-[project.urls]
-Homepage = "https://useknockout.com"
-Documentation = "https://github.com/useknockout/python"
-Repository = "https://github.com/useknockout/python"
-Issues = "https://github.com/useknockout/python/issues"
-
-[tool.hatch.build.targets.wheel]
-packages = ["src/useknockout"]
-
-[tool.ruff]
-line-length = 100
-target-version = "py39"
-
-[tool.ruff.lint]
-select = ["E", "F", "I", "W", "UP"]
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "useknockout"
+version = "0.0.4"
+description = "Python SDK for useknockout — state-of-the-art background removal API."
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.9"
+authors = [{ name = "useknockout" }]
+keywords = [
+    "background-removal",
+    "remove-background",
+    "birefnet",
+    "ai",
+    "image-processing",
+    "useknockout",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Multimedia :: Graphics",
+    "Topic :: Scientific/Engineering :: Image Processing",
+]
+dependencies = [
+    "httpx>=0.27.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-asyncio>=0.23",
+    "ruff>=0.6.0",
+    "mypy>=1.10",
+]
+
+[project.urls]
+Homepage = "https://useknockout.com"
+Documentation = "https://github.com/useknockout/python"
+Repository = "https://github.com/useknockout/python"
+Issues = "https://github.com/useknockout/python/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/useknockout"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "W", "UP"]

{useknockout-0.0.2 → useknockout-0.0.4}/src/useknockout/__init__.py

@@ -1,47 +1,47 @@
-"""
-useknockout — state-of-the-art background removal API.
-
-Quickstart:
-
-    from useknockout import Knockout
-
-    client = Knockout(token="kno_public_beta_4d7e9f1a3c5b2e8d6a9f7c1b3e5d8a2f")
-    png_bytes = client.remove("photo.jpg")
-    open("out.png", "wb").write(png_bytes)
-
-Async:
-
-    import asyncio
-    from useknockout import AsyncKnockout
-
-    async def main():
-        async with AsyncKnockout(token="...") as client:
-            png = await client.remove("photo.jpg")
-            open("out.png", "wb").write(png)
-
-    asyncio.run(main())
-"""
-
-from useknockout._version import __version__
-from useknockout.client import Knockout
-from useknockout.async_client import AsyncKnockout
-from useknockout.errors import (
-    KnockoutError,
-    AuthError,
-    BadRequestError,
-    PayloadTooLargeError,
-    RateLimitError,
-    ServerError,
-)
-
-__all__ = [
-    "__version__",
-    "Knockout",
-    "AsyncKnockout",
-    "KnockoutError",
-    "AuthError",
-    "BadRequestError",
-    "PayloadTooLargeError",
-    "RateLimitError",
-    "ServerError",
-]
+"""
+useknockout — state-of-the-art background removal API.
+
+Quickstart:
+
+    from useknockout import Knockout
+
+    client = Knockout(token="kno_public_beta_4d7e9f1a3c5b2e8d6a9f7c1b3e5d8a2f")
+    png_bytes = client.remove("photo.jpg")
+    open("out.png", "wb").write(png_bytes)
+
+Async:
+
+    import asyncio
+    from useknockout import AsyncKnockout
+
+    async def main():
+        async with AsyncKnockout(token="...") as client:
+            png = await client.remove("photo.jpg")
+            open("out.png", "wb").write(png)
+
+    asyncio.run(main())
+"""
+
+from useknockout._version import __version__
+from useknockout.client import Knockout
+from useknockout.async_client import AsyncKnockout
+from useknockout.errors import (
+    KnockoutError,
+    AuthError,
+    BadRequestError,
+    PayloadTooLargeError,
+    RateLimitError,
+    ServerError,
+)
+
+__all__ = [
+    "__version__",
+    "Knockout",
+    "AsyncKnockout",
+    "KnockoutError",
+    "AuthError",
+    "BadRequestError",
+    "PayloadTooLargeError",
+    "RateLimitError",
+    "ServerError",
+]