runapi-recraft 0.1.0__py3-none-any.whl

runapi/recraft/__init__.py

@@ -0,0 +1,24 @@
+"""Recraft client for RunAPI."""
+
+from runapi.core import (
+    AuthenticationError,
+    InsufficientCreditsError,
+    NotFoundError,
+    RateLimitError,
+    TaskFailedError,
+    TaskTimeoutError,
+    ValidationError,
+)
+
+from .client import RecraftClient
+
+__all__ = [
+    "RecraftClient",
+    "AuthenticationError",
+    "RateLimitError",
+    "InsufficientCreditsError",
+    "NotFoundError",
+    "ValidationError",
+    "TaskFailedError",
+    "TaskTimeoutError",
+]

runapi/recraft/client.py

@@ -0,0 +1,30 @@
+"""Recraft client."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from runapi.core import ClientOptions, HttpClient, resolve_api_key
+
+from .resources.remove_background import RemoveBackground
+from .resources.upscale_image import UpscaleImage
+
+
+class RecraftClient:
+    """Recraft image upscale and background-removal client.
+
+    Example::
+
+        client = RecraftClient(api_key="sk-...")
+        result = client.upscale_image.run(
+            model="recraft-crisp-upscale",
+            source_image_url="https://example.com/source.jpg",
+        )
+    """
+
+    def __init__(self, api_key: Optional[str] = None, **options: Any) -> None:
+        resolved_api_key = resolve_api_key(api_key)
+        client_options = ClientOptions(api_key=resolved_api_key, **options)
+        http = client_options.http_client or HttpClient(client_options)
+        self.upscale_image = UpscaleImage(http)
+        self.remove_background = RemoveBackground(http)

runapi/recraft/contract_gen.py

@@ -0,0 +1,22 @@
+CONTRACT = {
+    "remove-background": {
+        "models": ["recraft-remove-background"],
+        "fields_by_model": {
+            "recraft-remove-background": {
+                "source_image_url": {
+                    "required": True
+                }
+            }
+        }
+    },
+    "upscale-image": {
+        "models": ["recraft-crisp-upscale"],
+        "fields_by_model": {
+            "recraft-crisp-upscale": {
+                "source_image_url": {
+                    "required": True
+                }
+            }
+        }
+    }
+}

runapi/recraft/resources/__init__.py

@@ -0,0 +1,4 @@
+from .remove_background import RemoveBackground
+from .upscale_image import UpscaleImage
+
+__all__ = ["UpscaleImage", "RemoveBackground"]

runapi/recraft/resources/remove_background.py

@@ -0,0 +1,58 @@
+"""Recraft remove-background resource."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from runapi.core import Resource
+
+from ..contract_gen import CONTRACT
+from ..types import (
+    CompletedImageTaskResponse,
+    ImageTaskResponse,
+)
+
+
+class RemoveBackground(Resource):
+    """Remove image backgrounds with Recraft models."""
+
+    ENDPOINT = "/api/v1/recraft/remove_background"
+
+    RESPONSE_CLASS = ImageTaskResponse
+    COMPLETED_RESPONSE_CLASS = CompletedImageTaskResponse
+
+    def run(self, **params: Any) -> Any:
+        """Run a remove-background task and poll until it completes.
+
+        Args:
+            **params: remove-background parameters (model, ...).
+
+        Returns:
+            The completed (narrowed) remove-background response.
+        """
+        task = self.create(**params)
+        return self._poll_until_complete(lambda: self.get(task.id))
+
+    def create(self, **params: Any) -> Any:
+        """Create a remove-background task and return immediately with an id.
+
+        Args:
+            **params: remove-background parameters (model, ...).
+
+        Returns:
+            The task creation result with an id.
+        """
+        compacted = self._compact_params(params)
+        self._validate_contract(CONTRACT["remove-background"], compacted)
+        return self._request("post", self.ENDPOINT, body=compacted)
+
+    def get(self, id: str) -> Any:
+        """Fetch the current status of a remove-background task.
+
+        Args:
+            id: The task id returned by ``create``.
+
+        Returns:
+            The current task status.
+        """
+        return self._request("get", f"{self.ENDPOINT}/{id}")

runapi/recraft/resources/upscale_image.py

@@ -0,0 +1,58 @@
+"""Recraft upscale-image resource."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from runapi.core import Resource
+
+from ..contract_gen import CONTRACT
+from ..types import (
+    CompletedImageTaskResponse,
+    ImageTaskResponse,
+)
+
+
+class UpscaleImage(Resource):
+    """Upscale images with Recraft models."""
+
+    ENDPOINT = "/api/v1/recraft/upscale_image"
+
+    RESPONSE_CLASS = ImageTaskResponse
+    COMPLETED_RESPONSE_CLASS = CompletedImageTaskResponse
+
+    def run(self, **params: Any) -> Any:
+        """Run an image upscale task and poll until it completes.
+
+        Args:
+            **params: image upscale parameters (model, ...).
+
+        Returns:
+            The completed (narrowed) image upscale response.
+        """
+        task = self.create(**params)
+        return self._poll_until_complete(lambda: self.get(task.id))
+
+    def create(self, **params: Any) -> Any:
+        """Create an image upscale task and return immediately with an id.
+
+        Args:
+            **params: image upscale parameters (model, ...).
+
+        Returns:
+            The task creation result with an id.
+        """
+        compacted = self._compact_params(params)
+        self._validate_contract(CONTRACT["upscale-image"], compacted)
+        return self._request("post", self.ENDPOINT, body=compacted)
+
+    def get(self, id: str) -> Any:
+        """Fetch the current status of an image upscale task.
+
+        Args:
+            id: The task id returned by ``create``.
+
+        Returns:
+            The current task status.
+        """
+        return self._request("get", f"{self.ENDPOINT}/{id}")

runapi/recraft/types.py

@@ -0,0 +1,24 @@
+"""Recraft model lists and response models."""
+
+from __future__ import annotations
+
+from runapi.core import BaseModel, TaskResponse, optional, required
+
+
+class Image(BaseModel):
+    url = optional(str)
+
+
+class ImageTaskResponse(TaskResponse):
+    """Recraft image task status response."""
+
+    id = required(str)
+    status = optional(str, enum=lambda: TaskResponse.Status.ALL)
+    images = optional([lambda: Image])
+    error = optional(str)
+
+
+class CompletedImageTaskResponse(ImageTaskResponse):
+    """Narrowed response from ``run()`` once polling observes completion."""
+
+    images = required([lambda: Image])

runapi_recraft-0.1.0.dist-info/METADATA

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: runapi-recraft
+Version: 0.1.0
+Summary: Recraft image upscale and background-removal client for RunAPI
+Project-URL: Homepage, https://runapi.ai/models/recraft
+Project-URL: Documentation, https://runapi.ai/docs#sdk-recraft
+Author-email: RunAPI <contact@runapi.ai>
+License-Expression: Apache-2.0
+Keywords: ai,recraft,remove-background,runapi,sdk,upscale-image
+Requires-Python: >=3.9
+Requires-Dist: runapi-core
+Description-Content-Type: text/markdown
+
+# Recraft Python SDK for RunAPI
+
+The Recraft Python SDK is the language-specific package for Recraft on RunAPI.
+Use it for image upscale and background-removal flows when your application needs
+JSON request bodies, task status lookup, and consistent RunAPI errors in Python.
+
+For model details, use https://runapi.ai/models/recraft; for API reference, use
+https://runapi.ai/docs#recraft; for SDK docs, use https://runapi.ai/docs#sdk-recraft.
+
+## Install
+
+```bash
+pip install runapi-recraft
+```
+
+## Quick start
+
+```python
+from runapi.recraft import RecraftClient
+
+client = RecraftClient()  # reads RUNAPI_API_KEY, or pass api_key="sk-..."
+
+task = client.upscale_image.create(
+    model="recraft-crisp-upscale",
+    source_image_url="https://example.com/source.jpg",
+)
+status = client.upscale_image.get(task.id)
+
+removed = client.remove_background.create(
+    model="recraft-remove-background",
+    source_image_url="https://example.com/source.jpg",
+)
+```
+
+Use `create` to submit a task and return quickly, `get` to fetch the latest task
+state, and `run` to create and poll until completion:
+
+```python
+result = client.upscale_image.run(
+    model="recraft-crisp-upscale",
+    source_image_url="https://example.com/source.jpg",
+)
+print(result.images[0].url)
+```
+
+In web request handlers, prefer `create` plus webhook or later `get` polling so a
+worker is not held open.
+
+RunAPI-generated file URLs are temporary. Download and store generated images in
+your own durable storage within 7 days; do not treat returned URLs as long-term
+assets.
+
+## Language notes
+
+Pass parameters as keyword arguments and catch the `runapi.recraft` error
+classes when building image jobs or scripts. The available resources are
+`upscale_image` and `remove_background`. Keep `RUNAPI_API_KEY` in the environment
+or your secret manager; never commit API keys or callback secrets.
+
+## Links
+
+- Model page: https://runapi.ai/models/recraft
+- SDK docs: https://runapi.ai/docs#sdk-recraft
+- Product docs: https://runapi.ai/docs#recraft
+- Pricing and rate limits: https://runapi.ai/models/recraft
+- Full catalog: https://runapi.ai/models
+
+## License
+
+Licensed under the Apache License, Version 2.0.

runapi_recraft-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+runapi/recraft/__init__.py,sha256=WpRITiBp2AA1_uUyWtSg8OwDu6GT_G0mw2NrO1jS20c,463
+runapi/recraft/client.py,sha256=npY8VshJxNbCUTdbz6ehjzeyOk5xrTQgsjrTlxHDhAE,968
+runapi/recraft/contract_gen.py,sha256=hzlVmcX5IkmTXWmcPY-WE2lrLj6GcK_-SwrsLREFdOY,546
+runapi/recraft/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+runapi/recraft/types.py,sha256=NwSfiakzoqmXeyN24CbhS1DZAuYpetJH0h30FW2iVQo,615
+runapi/recraft/resources/__init__.py,sha256=zVY8SPzJ9lGQuZw6UsNHZG6hb3x-oHhrLRQejfh7r_M,136
+runapi/recraft/resources/remove_background.py,sha256=hs_giaVQ3713cbDpzm7gdHOdwJ_i5WdB58sQ_WnCzGo,1654
+runapi/recraft/resources/upscale_image.py,sha256=ib-vFJptYEUsR2PnWHciAYQI0FtkPgvbu5HMT136j4A,1607
+runapi_recraft-0.1.0.dist-info/METADATA,sha256=JKhh2nMQFrKRFtR6Un4pwIaOtxAUC1ddaQ9EopWbmJM,2644
+runapi_recraft-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+runapi_recraft-0.1.0.dist-info/RECORD,,

runapi_recraft-0.1.0.dist-info/WHEEL

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