runapi-runway 0.1.0__tar.gz

runapi_runway-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_runway-0.1.0/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: runapi-runway
+Version: 0.1.0
+Summary: Runway text-to-video and extend-video client for RunAPI
+Project-URL: Homepage, https://runapi.ai/models/runway
+Project-URL: Documentation, https://runapi.ai/docs#sdk-runway
+Author-email: RunAPI <contact@runapi.ai>
+License-Expression: Apache-2.0
+Keywords: ai,extend-video,runapi,runway,sdk,text-to-video
+Requires-Python: >=3.9
+Requires-Dist: runapi-core
+Description-Content-Type: text/markdown
+
+# Runway Python SDK for RunAPI
+
+The Runway Python SDK is the language-specific package for Runway on RunAPI.
+Use it for text-to-video and extend-video 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/runway; for API reference, use
+https://runapi.ai/docs#runway; for SDK docs, use https://runapi.ai/docs#sdk-runway.
+
+## Install
+
+```bash
+pip install runapi-runway
+```
+
+## Quick start
+
+```python
+from runapi.runway import RunwayClient
+
+client = RunwayClient()  # reads RUNAPI_API_KEY, or pass api_key="sk-..."
+
+task = client.text_to_video.create(
+    model="...",
+    prompt="A drone shot over a coastal city at sunset, cinematic",
+    duration_seconds=5,
+    output_resolution="720p",
+    aspect_ratio="16:9",
+)
+status = client.text_to_video.get(task.id)
+
+extended = client.extend_video.create(
+    model="...",
+    source_task_id=task.id,
+    prompt="Continue the camera push toward the harbor",
+    output_resolution="720p",
+)
+```
+
+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_video.run(
+    model="...",
+    prompt="A serene mountain lake at dawn, slow pan",
+    duration_seconds=5,
+    output_resolution="720p",
+)
+print(result.videos[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 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.runway` error classes
+when building video jobs or scripts. The available resources are `text_to_video`
+and `extend_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/runway
+- SDK docs: https://runapi.ai/docs#sdk-runway
+- Product docs: https://runapi.ai/docs#runway
+- Pricing and rate limits: https://runapi.ai/models/runway
+- Full catalog: https://runapi.ai/models
+
+## License
+
+Licensed under the Apache License, Version 2.0.

runapi_runway-0.1.0/README.md

@@ -0,0 +1,77 @@
+# Runway Python SDK for RunAPI
+
+The Runway Python SDK is the language-specific package for Runway on RunAPI.
+Use it for text-to-video and extend-video 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/runway; for API reference, use
+https://runapi.ai/docs#runway; for SDK docs, use https://runapi.ai/docs#sdk-runway.
+
+## Install
+
+```bash
+pip install runapi-runway
+```
+
+## Quick start
+
+```python
+from runapi.runway import RunwayClient
+
+client = RunwayClient()  # reads RUNAPI_API_KEY, or pass api_key="sk-..."
+
+task = client.text_to_video.create(
+    model="...",
+    prompt="A drone shot over a coastal city at sunset, cinematic",
+    duration_seconds=5,
+    output_resolution="720p",
+    aspect_ratio="16:9",
+)
+status = client.text_to_video.get(task.id)
+
+extended = client.extend_video.create(
+    model="...",
+    source_task_id=task.id,
+    prompt="Continue the camera push toward the harbor",
+    output_resolution="720p",
+)
+```
+
+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_video.run(
+    model="...",
+    prompt="A serene mountain lake at dawn, slow pan",
+    duration_seconds=5,
+    output_resolution="720p",
+)
+print(result.videos[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 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.runway` error classes
+when building video jobs or scripts. The available resources are `text_to_video`
+and `extend_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/runway
+- SDK docs: https://runapi.ai/docs#sdk-runway
+- Product docs: https://runapi.ai/docs#runway
+- Pricing and rate limits: https://runapi.ai/models/runway
+- Full catalog: https://runapi.ai/models
+
+## License
+
+Licensed under the Apache License, Version 2.0.

runapi_runway-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "runapi-runway"
+version = "0.1.0"
+description = "Runway text-to-video and extend-video client for RunAPI"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "Apache-2.0"
+authors = [{ name = "RunAPI", email = "contact@runapi.ai" }]
+keywords = ["runapi", "runway", "text-to-video", "extend-video", "ai", "sdk"]
+dependencies = ["runapi-core"]
+
+[project.urls]
+Homepage = "https://runapi.ai/models/runway"
+Documentation = "https://runapi.ai/docs#sdk-runway"
+
+[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 = "runway"

runapi_runway-0.1.0/src/runapi/runway/__init__.py

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

runapi_runway-0.1.0/src/runapi/runway/client.py

@@ -0,0 +1,32 @@
+"""Runway client."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from runapi.core import ClientOptions, HttpClient, resolve_api_key
+
+from .resources.extend_video import ExtendVideo
+from .resources.text_to_video import TextToVideo
+
+
+class RunwayClient:
+    """Runway text-to-video and extend-video client.
+
+    Example::
+
+        client = RunwayClient(api_key="sk-...")
+        result = client.text_to_video.run(
+            model="...",
+            prompt="A drone shot over a coastal city at sunset",
+            duration_seconds=5,
+            output_resolution="720p",
+        )
+    """
+
+    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_video = TextToVideo(http)
+        self.extend_video = ExtendVideo(http)

runapi_runway-0.1.0/src/runapi/runway/contract_gen.py

@@ -0,0 +1,41 @@
+CONTRACT = {
+    "extend-video": {
+        "models": ["runway"],
+        "fields_by_model": {
+            "runway": {
+                "output_resolution": {
+                    "enum": ["720p", "1080p"],
+                    "required": True
+                },
+                "prompt": {
+                    "required": True
+                },
+                "source_task_id": {
+                    "required": True
+                }
+            }
+        }
+    },
+    "text-to-video": {
+        "models": ["runway"],
+        "fields_by_model": {
+            "runway": {
+                "aspect_ratio": {
+                    "enum": ["16:9", "9:16", "1:1", "4:3", "3:4"]
+                },
+                "duration_seconds": {
+                    "enum": [5, 10],
+                    "required": True,
+                    "type": "integer"
+                },
+                "output_resolution": {
+                    "enum": ["720p", "1080p"],
+                    "required": True
+                },
+                "prompt": {
+                    "required": True
+                }
+            }
+        }
+    }
+}

runapi_runway-0.1.0/src/runapi/runway/resources/__init__.py

@@ -0,0 +1,4 @@
+from .extend_video import ExtendVideo
+from .text_to_video import TextToVideo
+
+__all__ = ["TextToVideo", "ExtendVideo"]

runapi_runway-0.1.0/src/runapi/runway/resources/extend_video.py

@@ -0,0 +1,60 @@
+"""Runway extend-video resource."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from runapi.core import Resource
+
+from ..contract_gen import CONTRACT
+from ..types import (
+    CompletedTaskResponse,
+    TaskCreateResponse,
+)
+
+
+class ExtendVideo(Resource):
+    """Extend an existing Runway video task."""
+
+    ENDPOINT = "/api/v1/runway/extend_video"
+
+    RESPONSE_CLASS = TaskCreateResponse
+    COMPLETED_RESPONSE_CLASS = CompletedTaskResponse
+
+    MODEL = "runway"
+
+    def run(self, **params: Any) -> Any:
+        """Append footage to a previous video and poll until it completes.
+
+        Args:
+            **params: extend-video parameters (model, ...).
+
+        Returns:
+            The completed (narrowed) extend-video response.
+        """
+        task = self.create(**params)
+        return self._poll_until_complete(lambda: self.get(task.id))
+
+    def create(self, **params: Any) -> Any:
+        """Create an extend-video task and return immediately with an id.
+
+        Args:
+            **params: extend-video parameters (model, ...).
+
+        Returns:
+            The task creation result with an id.
+        """
+        compacted = self._compact_params(params)
+        self._validate_contract(CONTRACT["extend-video"], {**compacted, "model": self.MODEL})
+        return self._request("post", self.ENDPOINT, body=compacted)
+
+    def get(self, id: str) -> Any:
+        """Fetch the current status of an extend-video task.
+
+        Args:
+            id: The task id returned by ``create``.
+
+        Returns:
+            The current task status.
+        """
+        return self._request("get", f"{self.ENDPOINT}/{id}")

runapi_runway-0.1.0/src/runapi/runway/resources/text_to_video.py

@@ -0,0 +1,60 @@
+"""Runway text-to-video resource."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from runapi.core import Resource
+
+from ..contract_gen import CONTRACT
+from ..types import (
+    CompletedTaskResponse,
+    TaskCreateResponse,
+)
+
+
+class TextToVideo(Resource):
+    """Generate videos from text prompts with Runway models."""
+
+    ENDPOINT = "/api/v1/runway/text_to_video"
+
+    RESPONSE_CLASS = TaskCreateResponse
+    COMPLETED_RESPONSE_CLASS = CompletedTaskResponse
+
+    MODEL = "runway"
+
+    def run(self, **params: Any) -> Any:
+        """Create a text-to-video task and poll until it completes.
+
+        Args:
+            **params: text-to-video parameters (model, ...).
+
+        Returns:
+            The completed (narrowed) text-to-video 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-video task and return immediately with an id.
+
+        Args:
+            **params: text-to-video parameters (model, ...).
+
+        Returns:
+            The task creation result with an id.
+        """
+        compacted = self._compact_params(params)
+        self._validate_contract(CONTRACT["text-to-video"], {**compacted, "model": self.MODEL})
+        return self._request("post", self.ENDPOINT, body=compacted)
+
+    def get(self, id: str) -> Any:
+        """Fetch the current status of a text-to-video task.
+
+        Args:
+            id: The task id returned by ``create``.
+
+        Returns:
+            The current task status.
+        """
+        return self._request("get", f"{self.ENDPOINT}/{id}")

runapi_runway-0.1.0/src/runapi/runway/types.py

@@ -0,0 +1,35 @@
+"""Runway enums and response models."""
+
+from __future__ import annotations
+
+from runapi.core import BaseModel, TaskResponse, optional, required
+
+
+class Video(BaseModel):
+    id = optional(str)
+    url = required(str)
+
+
+class Image(BaseModel):
+    url = required(str)
+
+
+class TaskResponseModel(TaskResponse):
+    """Runway task status response."""
+
+    id = required(str)
+    status = optional(str, enum=lambda: TaskResponse.Status.ALL)
+    videos = optional([lambda: Video])
+    images = optional([lambda: Image])
+    source_task_id = optional(str)
+    error = optional(str)
+
+
+class TaskCreateResponse(TaskResponseModel):
+    """Runway task creation response with an id."""
+
+
+class CompletedTaskResponse(TaskResponseModel):
+    """Narrowed response from ``run()`` once polling observes completion."""
+
+    videos = required([lambda: Video])

runapi_runway-0.1.0/tests/test_client.py

@@ -0,0 +1,210 @@
+import pytest
+
+from runapi.core import config
+from runapi.core.errors import AuthenticationError, ValidationError
+from runapi.runway import RunwayClient
+from runapi.runway.resources.extend_video import ExtendVideo
+from runapi.runway.resources.text_to_video import TextToVideo
+from runapi.runway.types import CompletedTaskResponse, TaskCreateResponse
+
+
+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(RunwayClient(api_key="k", http_client=FakeHttp()), RunwayClient)
+
+
+def test_falls_back_to_global(monkeypatch):
+    monkeypatch.setattr(config, "api_key", "global-key")
+    assert isinstance(RunwayClient(http_client=FakeHttp()), RunwayClient)
+
+
+def test_falls_back_to_env(monkeypatch):
+    monkeypatch.setenv("RUNAPI_API_KEY", "env-key")
+    assert isinstance(RunwayClient(http_client=FakeHttp()), RunwayClient)
+
+
+def test_raises_without_api_key():
+    with pytest.raises(AuthenticationError, match="API key is required"):
+        RunwayClient()
+
+
+# --- injection / accessors ------------------------------------------------
+
+
+def test_uses_injected_http_client():
+    fake = FakeHttp()
+    client = RunwayClient(api_key="k", http_client=fake)
+    assert client.text_to_video._http is fake
+    assert client.extend_video._http is fake
+
+
+def test_exposes_resource_accessors():
+    client = RunwayClient(api_key="k", http_client=FakeHttp())
+    assert isinstance(client.text_to_video, TextToVideo)
+    assert isinstance(client.extend_video, ExtendVideo)
+
+
+# --- request shapes -------------------------------------------------------
+
+
+def test_create_posts_compacted_body():
+    fake = FakeHttp({"id": "t1", "status": "pending"})
+    client = RunwayClient(api_key="k", http_client=fake)
+    result = client.text_to_video.create(
+        prompt="hello world",
+        duration_seconds=5,
+        output_resolution="720p",
+        aspect_ratio="16:9",
+        seed=None,
+    )
+    assert fake.calls == [
+        (
+            "post",
+            "/api/v1/runway/text_to_video",
+            {
+                "prompt": "hello world",
+                "duration_seconds": 5,
+                "output_resolution": "720p",
+                "aspect_ratio": "16:9",
+            },
+        ),
+    ]
+    _, _, body = fake.calls[0]
+    assert "model" not in body
+    assert isinstance(result, TaskCreateResponse)
+
+
+def test_get_fetches_by_id():
+    fake = FakeHttp({"id": "t1", "status": "processing"})
+    client = RunwayClient(api_key="k", http_client=fake)
+    client.text_to_video.get("t1")
+    assert fake.calls == [("get", "/api/v1/runway/text_to_video/t1", None)]
+
+
+def test_extend_video_create_posts_compacted_body():
+    fake = FakeHttp({"id": "t2", "status": "pending"})
+    client = RunwayClient(api_key="k", http_client=fake)
+    client.extend_video.create(
+        source_task_id="t1",
+        prompt="keep going",
+        output_resolution="1080p",
+    )
+    assert fake.calls == [
+        (
+            "post",
+            "/api/v1/runway/extend_video",
+            {
+                "source_task_id": "t1",
+                "prompt": "keep going",
+                "output_resolution": "1080p",
+            },
+        ),
+    ]
+    _, _, body = fake.calls[0]
+    assert "model" not in body
+
+
+def test_run_narrows_completed_type():
+    fake = FakeHttp(
+        {"id": "t1", "status": "pending"},
+        {"id": "t1", "status": "completed", "videos": [{"url": "https://x/y.mp4"}]},
+    )
+    client = RunwayClient(api_key="k", http_client=fake)
+    result = client.text_to_video.run(
+        model="runway",
+        prompt="a serene lake",
+        duration_seconds=5,
+        output_resolution="720p",
+    )
+    assert isinstance(result, CompletedTaskResponse)
+    assert result.videos[0].url == "https://x/y.mp4"
+
+
+# --- validation -----------------------------------------------------------
+
+
+def test_text_to_video_requires_prompt():
+    client = RunwayClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="prompt is required"):
+        client.text_to_video.create(
+            model="runway", duration_seconds=5, output_resolution="720p"
+        )
+
+
+def test_text_to_video_requires_duration_seconds():
+    client = RunwayClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="duration_seconds is required"):
+        client.text_to_video.create(
+            model="runway", prompt="hi there", output_resolution="720p"
+        )
+
+
+def test_text_to_video_requires_output_resolution():
+    client = RunwayClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="output_resolution is required"):
+        client.text_to_video.create(model="runway", prompt="hi there", duration_seconds=5)
+
+
+def test_text_to_video_rejects_invalid_output_resolution():
+    client = RunwayClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="output_resolution must be one of: 720p, 1080p"):
+        client.text_to_video.create(
+            model="runway", prompt="hi there", duration_seconds=5, output_resolution="480p"
+        )
+
+
+def test_text_to_video_rejects_invalid_aspect_ratio():
+    client = RunwayClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(
+        ValidationError, match="aspect_ratio must be one of: 16:9, 9:16, 1:1, 4:3, 3:4"
+    ):
+        client.text_to_video.create(
+            model="runway",
+            prompt="hi there",
+            duration_seconds=5,
+            output_resolution="720p",
+            aspect_ratio="21:9",
+        )
+
+
+def test_extend_video_requires_source_task_id():
+    client = RunwayClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="source_task_id is required"):
+        client.extend_video.create(
+            model="runway", prompt="hi there", output_resolution="720p"
+        )
+
+
+def test_extend_video_requires_prompt():
+    client = RunwayClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="prompt is required"):
+        client.extend_video.create(
+            model="runway", source_task_id="t1", output_resolution="720p"
+        )
+
+
+def test_extend_video_requires_output_resolution():
+    client = RunwayClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="output_resolution is required"):
+        client.extend_video.create(model="runway", source_task_id="t1", prompt="hi there")