runapi-topaz 0.1.0__py3-none-any.whl

runapi/topaz/__init__.py

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

runapi/topaz/client.py

@@ -0,0 +1,31 @@
+"""Topaz client."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from runapi.core import ClientOptions, HttpClient, resolve_api_key
+
+from .resources.upscale_image import UpscaleImage
+from .resources.upscale_video import UpscaleVideo
+
+
+class TopazClient:
+    """Topaz image and video upscale client.
+
+    Example::
+
+        client = TopazClient(api_key="sk-...")
+        result = client.upscale_image.run(
+            model="topaz-upscale-image",
+            source_image_url="https://example.com/in.jpg",
+            upscale_factor=4,
+        )
+    """
+
+    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.upscale_video = UpscaleVideo(http)

runapi/topaz/contract_gen.py

@@ -0,0 +1,31 @@
+CONTRACT = {
+    "upscale-image": {
+        "models": ["topaz-upscale-image"],
+        "fields_by_model": {
+            "topaz-upscale-image": {
+                "source_image_url": {
+                    "required": True
+                },
+                "upscale_factor": {
+                    "enum": [1, 2, 4, 8],
+                    "required": True,
+                    "type": "integer"
+                }
+            }
+        }
+    },
+    "upscale-video": {
+        "models": ["topaz-upscale-video"],
+        "fields_by_model": {
+            "topaz-upscale-video": {
+                "source_video_url": {
+                    "required": True
+                },
+                "upscale_factor": {
+                    "enum": [1, 2, 4],
+                    "type": "integer"
+                }
+            }
+        }
+    }
+}

runapi/topaz/resources/__init__.py

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

runapi/topaz/resources/upscale_image.py

@@ -0,0 +1,58 @@
+"""Topaz upscale-image resource."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from runapi.core import Resource
+
+from ..contract_gen import CONTRACT
+from ..types import (
+    CompletedUpscaleImageResponse,
+    UpscaleImageResponse,
+)
+
+
+class UpscaleImage(Resource):
+    """Upscale images with Topaz."""
+
+    ENDPOINT = "/api/v1/topaz/upscale_image"
+
+    RESPONSE_CLASS = UpscaleImageResponse
+    COMPLETED_RESPONSE_CLASS = CompletedUpscaleImageResponse
+
+    def run(self, **params: Any) -> Any:
+        """Upscale an image 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/topaz/resources/upscale_video.py

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

runapi/topaz/types.py

@@ -0,0 +1,43 @@
+"""Topaz response models."""
+
+from __future__ import annotations
+
+from runapi.core import BaseModel, TaskResponse, optional, required
+
+
+class Image(BaseModel):
+    url = optional(str)
+
+
+class Video(BaseModel):
+    url = optional(str)
+
+
+class UpscaleImageResponse(TaskResponse):
+    """Topaz image upscale task status response."""
+
+    id = required(str)
+    status = optional(str, enum=lambda: TaskResponse.Status.ALL)
+    images = optional([lambda: Image])
+    error = optional(str)
+
+
+class UpscaleVideoResponse(TaskResponse):
+    """Topaz video upscale task status response."""
+
+    id = required(str)
+    status = optional(str, enum=lambda: TaskResponse.Status.ALL)
+    videos = optional([lambda: Video])
+    error = optional(str)
+
+
+class CompletedUpscaleImageResponse(UpscaleImageResponse):
+    """Narrowed response from ``run()`` once polling observes completion."""
+
+    images = required([lambda: Image])
+
+
+class CompletedUpscaleVideoResponse(UpscaleVideoResponse):
+    """Narrowed response from ``run()`` once polling observes completion."""
+
+    videos = required([lambda: Video])

runapi_topaz-0.1.0.dist-info/METADATA

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: runapi-topaz
+Version: 0.1.0
+Summary: Topaz image and video upscale client for RunAPI
+Project-URL: Homepage, https://runapi.ai/models/topaz
+Project-URL: Documentation, https://runapi.ai/docs#sdk-topaz
+Author-email: RunAPI <contact@runapi.ai>
+License-Expression: Apache-2.0
+Keywords: ai,runapi,sdk,topaz,upscale-image,upscale-video
+Requires-Python: >=3.9
+Requires-Dist: runapi-core
+Description-Content-Type: text/markdown
+
+# Topaz Python SDK for RunAPI
+
+The Topaz Python SDK is the language-specific package for Topaz on RunAPI. Use it
+for image upscale and video upscale 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/topaz; for API reference, use
+https://runapi.ai/docs#topaz; for SDK docs, use https://runapi.ai/docs#sdk-topaz.
+
+## Install
+
+```bash
+pip install runapi-topaz
+```
+
+## Quick start
+
+```python
+from runapi.topaz import TopazClient
+
+client = TopazClient()  # reads RUNAPI_API_KEY, or pass api_key="sk-..."
+
+task = client.upscale_image.create(
+    model="topaz-upscale-image",
+    source_image_url="https://example.com/in.jpg",
+    upscale_factor=4,
+)
+status = client.upscale_image.get(task.id)
+
+video = client.upscale_video.create(
+    model="topaz-upscale-video",
+    source_video_url="https://example.com/in.mp4",
+    upscale_factor=2,
+)
+```
+
+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="topaz-upscale-image",
+    source_image_url="https://example.com/in.jpg",
+    upscale_factor=4,
+)
+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 and
+videos 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.topaz` error classes
+when building upscaling jobs or scripts. The available resources are
+`upscale_image` and `upscale_video`. 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/topaz
+- SDK docs: https://runapi.ai/docs#sdk-topaz
+- Product docs: https://runapi.ai/docs#topaz
+- Pricing and rate limits: https://runapi.ai/models/topaz
+- Full catalog: https://runapi.ai/models
+
+## License
+
+Licensed under the Apache License, Version 2.0.

runapi_topaz-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+runapi/topaz/__init__.py,sha256=8f27JnhHBgxeOA2nJQL8dohGd3cg-xjzI1phU2K5_nI,457
+runapi/topaz/client.py,sha256=8owDlzgRQkZ7MwK_2MpgIQdWkbfbIfk5PXTZs7nHZqA,955
+runapi/topaz/contract_gen.py,sha256=n_NPJVzHB8P6B9ioncE1QOIBqh_QFJzx6HCIBWG4Kcs,831
+runapi/topaz/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+runapi/topaz/types.py,sha256=O_-QKRffiJJFN6p_fNgbqHI-tEJk_wk1PUui8yWaFB4,1090
+runapi/topaz/resources/__init__.py,sha256=0ALsFeXvjqJCaqpTFNWGdDHcA944GGEIVMTJ-0TK50M,124
+runapi/topaz/resources/upscale_image.py,sha256=kH-wll7ySJMKy1_C7cxvdP9M4Ocg1Eo9tHyk1BVumVc,1597
+runapi/topaz/resources/upscale_video.py,sha256=XLjHg6-GZMLdSopkQdqi6duQ-G5EKo03_X4UZADr4IM,1594
+runapi_topaz-0.1.0.dist-info/METADATA,sha256=LsWKYnPZUBHq0_g3nTwmTL0KHhwP9DhNFJuAR1YPeZw,2631
+runapi_topaz-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+runapi_topaz-0.1.0.dist-info/RECORD,,

runapi_topaz-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