runapi-z-image 0.1.0__tar.gz

runapi_z_image-0.1.0/.gitignore

@@ -0,0 +1,29 @@
+# Build artifacts
+dist/
+build/
+*.egg-info/
+*.egg
+
+# Bytecode
+__pycache__/
+*.py[cod]
+
+# Virtual environments
+.venv/
+venv/
+
+# uv
+uv.lock
+
+# Test / type caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# IDE / OS
+.idea/
+.vscode/
+*.swp
+.DS_Store

runapi_z_image-0.1.0/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.4
+Name: runapi-z-image
+Version: 0.1.0
+Summary: Z-Image text-to-image client for RunAPI
+Project-URL: Homepage, https://runapi.ai/models/z-image
+Project-URL: Documentation, https://runapi.ai/docs#sdk-z-image
+Author-email: RunAPI <contact@runapi.ai>
+License-Expression: Apache-2.0
+Keywords: ai,runapi,sdk,text-to-image,z-image
+Requires-Python: >=3.9
+Requires-Dist: runapi-core
+Description-Content-Type: text/markdown
+
+# Z-Image Python SDK for RunAPI
+
+The Z-Image Python SDK is the language-specific package for Z-Image on RunAPI.
+Use it for text-to-image 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/z-image; for API reference, use
+https://runapi.ai/docs#z-image; for SDK docs, use https://runapi.ai/docs#sdk-z-image.
+
+## Install
+
+```bash
+pip install runapi-z-image
+```
+
+## Quick start
+
+```python
+from runapi.z_image import ZImageClient
+
+client = ZImageClient()  # reads RUNAPI_API_KEY, or pass api_key="sk-..."
+
+task = client.text_to_image.create(
+    model="z-image",
+    prompt="A neon city street after rain, cinematic",
+    aspect_ratio="16:9",
+)
+status = client.text_to_image.get(task.id)
+```
+
+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.text_to_image.run(
+    model="z-image",
+    prompt="A serene mountain lake at dawn",
+    aspect_ratio="1:1",
+)
+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.z_image` error
+classes when building image jobs or scripts. The available resource is
+`text_to_image`. 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/z-image
+- SDK docs: https://runapi.ai/docs#sdk-z-image
+- Product docs: https://runapi.ai/docs#z-image
+- Pricing and rate limits: https://runapi.ai/models/z-image
+- Full catalog: https://runapi.ai/models
+
+## License
+
+Licensed under the Apache License, Version 2.0.

runapi_z_image-0.1.0/README.md

@@ -0,0 +1,67 @@
+# Z-Image Python SDK for RunAPI
+
+The Z-Image Python SDK is the language-specific package for Z-Image on RunAPI.
+Use it for text-to-image 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/z-image; for API reference, use
+https://runapi.ai/docs#z-image; for SDK docs, use https://runapi.ai/docs#sdk-z-image.
+
+## Install
+
+```bash
+pip install runapi-z-image
+```
+
+## Quick start
+
+```python
+from runapi.z_image import ZImageClient
+
+client = ZImageClient()  # reads RUNAPI_API_KEY, or pass api_key="sk-..."
+
+task = client.text_to_image.create(
+    model="z-image",
+    prompt="A neon city street after rain, cinematic",
+    aspect_ratio="16:9",
+)
+status = client.text_to_image.get(task.id)
+```
+
+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.text_to_image.run(
+    model="z-image",
+    prompt="A serene mountain lake at dawn",
+    aspect_ratio="1:1",
+)
+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.z_image` error
+classes when building image jobs or scripts. The available resource is
+`text_to_image`. 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/z-image
+- SDK docs: https://runapi.ai/docs#sdk-z-image
+- Product docs: https://runapi.ai/docs#z-image
+- Pricing and rate limits: https://runapi.ai/models/z-image
+- Full catalog: https://runapi.ai/models
+
+## License
+
+Licensed under the Apache License, Version 2.0.

runapi_z_image-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "runapi-z-image"
+version = "0.1.0"
+description = "Z-Image text-to-image client for RunAPI"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "Apache-2.0"
+authors = [{ name = "RunAPI", email = "contact@runapi.ai" }]
+keywords = ["runapi", "z-image", "text-to-image", "ai", "sdk"]
+dependencies = ["runapi-core"]
+
+[project.urls]
+Homepage = "https://runapi.ai/models/z-image"
+Documentation = "https://runapi.ai/docs#sdk-z-image"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/runapi"]
+
+[tool.uv]
+package = true
+
+[tool.uv.sources]
+runapi-core = { workspace = true }
+
+[dependency-groups]
+dev = ["pytest>=8"]
+
+[tool.runapi]
+slug = "z-image"

runapi_z_image-0.1.0/src/runapi/z_image/__init__.py

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

runapi_z_image-0.1.0/src/runapi/z_image/client.py

@@ -0,0 +1,27 @@
+"""Z-Image client."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from runapi.core import ClientOptions, HttpClient, resolve_api_key
+
+from .resources.text_to_image import TextToImage
+
+
+class ZImageClient:
+    """Z-Image text-to-image client.
+
+    Example::
+
+        client = ZImageClient(api_key="sk-...")
+        result = client.text_to_image.run(
+            model="z-image", prompt="A neon city street", aspect_ratio="1:1"
+        )
+    """
+
+    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.text_to_image = TextToImage(http)

runapi_z_image-0.1.0/src/runapi/z_image/contract_gen.py

@@ -0,0 +1,19 @@
+CONTRACT = {
+    "text-to-image": {
+        "models": ["z-image"],
+        "fields_by_model": {
+            "z-image": {
+                "aspect_ratio": {
+                    "enum": ["1:1", "4:3", "3:4", "16:9", "9:16"],
+                    "required": True
+                },
+                "prompt": {
+                    "required": True,
+                    "min": 1,
+                    "max": 1000,
+                    "length": True
+                }
+            }
+        }
+    }
+}

runapi_z_image-0.1.0/src/runapi/z_image/resources/__init__.py

@@ -0,0 +1,3 @@
+from .text_to_image import TextToImage
+
+__all__ = ["TextToImage"]

runapi_z_image-0.1.0/src/runapi/z_image/resources/text_to_image.py

@@ -0,0 +1,58 @@
+"""Z-Image text-to-image resource."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from runapi.core import Resource
+
+from ..contract_gen import CONTRACT
+from ..types import (
+    CompletedTextToImageResponse,
+    TextToImageResponse,
+)
+
+
+class TextToImage(Resource):
+    """Generate images from text prompts with Z-Image."""
+
+    ENDPOINT = "/api/v1/z_image/text_to_image"
+
+    RESPONSE_CLASS = TextToImageResponse
+    COMPLETED_RESPONSE_CLASS = CompletedTextToImageResponse
+
+    def run(self, **params: Any) -> Any:
+        """Create a text-to-image task and poll until it completes.
+
+        Args:
+            **params: text-to-image parameters (model, ...).
+
+        Returns:
+            The completed (narrowed) text-to-image response.
+        """
+        task = self.create(**params)
+        return self._poll_until_complete(lambda: self.get(task.id))
+
+    def create(self, **params: Any) -> Any:
+        """Create a text-to-image task and return immediately with an id.
+
+        Args:
+            **params: text-to-image parameters (model, ...).
+
+        Returns:
+            The task creation result with an id.
+        """
+        compacted = self._compact_params(params)
+        self._validate_contract(CONTRACT["text-to-image"], compacted)
+        return self._request("post", self.ENDPOINT, body=compacted)
+
+    def get(self, id: str) -> Any:
+        """Fetch the current status of a text-to-image task.
+
+        Args:
+            id: The task id returned by ``create``.
+
+        Returns:
+            The current task status.
+        """
+        return self._request("get", f"{self.ENDPOINT}/{id}")

runapi_z_image-0.1.0/src/runapi/z_image/types.py

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

runapi_z_image-0.1.0/tests/test_client.py

@@ -0,0 +1,128 @@
+import pytest
+
+from runapi.core import config
+from runapi.core.errors import AuthenticationError, ValidationError
+from runapi.z_image import ZImageClient
+from runapi.z_image.resources.text_to_image import TextToImage
+from runapi.z_image.types import CompletedTextToImageResponse, TextToImageResponse
+
+
+class FakeHttp:
+    def __init__(self, *responses):
+        self._responses = list(responses)
+        self.calls = []
+
+    def request(self, method, path, body=None, options=None):
+        self.calls.append((method, path, body))
+        if self._responses:
+            return self._responses.pop(0)
+        return {"id": "task_1", "status": "pending"}
+
+
+@pytest.fixture(autouse=True)
+def reset_config(monkeypatch):
+    monkeypatch.delenv("RUNAPI_API_KEY", raising=False)
+    monkeypatch.setattr(config, "api_key", None)
+    yield
+
+
+# --- auth -----------------------------------------------------------------
+
+
+def test_accepts_api_key_parameter():
+    assert isinstance(ZImageClient(api_key="k", http_client=FakeHttp()), ZImageClient)
+
+
+def test_falls_back_to_global(monkeypatch):
+    monkeypatch.setattr(config, "api_key", "global-key")
+    assert isinstance(ZImageClient(http_client=FakeHttp()), ZImageClient)
+
+
+def test_falls_back_to_env(monkeypatch):
+    monkeypatch.setenv("RUNAPI_API_KEY", "env-key")
+    assert isinstance(ZImageClient(http_client=FakeHttp()), ZImageClient)
+
+
+def test_raises_without_api_key():
+    with pytest.raises(AuthenticationError, match="API key is required"):
+        ZImageClient()
+
+
+# --- injection / accessors ------------------------------------------------
+
+
+def test_uses_injected_http_client():
+    fake = FakeHttp()
+    client = ZImageClient(api_key="k", http_client=fake)
+    assert client.text_to_image._http is fake
+
+
+def test_exposes_resource_accessors():
+    client = ZImageClient(api_key="k", http_client=FakeHttp())
+    assert isinstance(client.text_to_image, TextToImage)
+
+
+# --- request shapes -------------------------------------------------------
+
+
+def test_create_posts_compacted_body():
+    fake = FakeHttp({"id": "t1", "status": "pending"})
+    client = ZImageClient(api_key="k", http_client=fake)
+    result = client.text_to_image.create(
+        model="z-image", prompt="hello world", aspect_ratio="1:1", seed=None
+    )
+    assert fake.calls == [
+        ("post", "/api/v1/z_image/text_to_image", {"model": "z-image", "prompt": "hello world", "aspect_ratio": "1:1"}),
+    ]
+    assert isinstance(result, TextToImageResponse)
+
+
+def test_get_fetches_by_id():
+    fake = FakeHttp({"id": "t1", "status": "processing"})
+    client = ZImageClient(api_key="k", http_client=fake)
+    client.text_to_image.get("t1")
+    assert fake.calls == [("get", "/api/v1/z_image/text_to_image/t1", None)]
+
+
+def test_run_narrows_completed_type():
+    fake = FakeHttp(
+        {"id": "t1", "status": "pending"},
+        {"id": "t1", "status": "completed", "images": [{"url": "https://x/y.png"}]},
+    )
+    client = ZImageClient(api_key="k", http_client=fake)
+    result = client.text_to_image.run(model="z-image", prompt="a serene lake", aspect_ratio="1:1")
+    assert isinstance(result, CompletedTextToImageResponse)
+    assert result.images[0].url == "https://x/y.png"
+
+
+# --- validation -----------------------------------------------------------
+
+
+def test_requires_model():
+    client = ZImageClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="model must be one of: z-image"):
+        client.text_to_image.create(prompt="hi there", aspect_ratio="1:1")
+
+
+def test_requires_prompt():
+    client = ZImageClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="prompt is required"):
+        client.text_to_image.create(model="z-image", aspect_ratio="1:1")
+
+
+def test_requires_aspect_ratio():
+    client = ZImageClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="aspect_ratio is required"):
+        client.text_to_image.create(model="z-image", prompt="hi there")
+
+
+def test_rejects_unknown_model():
+    client = ZImageClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="model must be one of: z-image"):
+        client.text_to_image.create(model="nope", prompt="hi there", aspect_ratio="1:1")
+
+
+def test_rejects_invalid_aspect_ratio():
+    client = ZImageClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="aspect_ratio must be one of: 1:1, 4:3, 3:4, 16:9, 9:16"):
+        client.text_to_image.create(model="z-image", prompt="hi there", aspect_ratio="2:1")