runapi-luma 0.1.0__tar.gz

runapi_luma-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_luma-0.1.0/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.4
+Name: runapi-luma
+Version: 0.1.0
+Summary: Luma modify-video client for RunAPI
+Project-URL: Homepage, https://runapi.ai/models/luma
+Project-URL: Documentation, https://runapi.ai/docs#sdk-luma
+Author-email: RunAPI <contact@runapi.ai>
+License-Expression: Apache-2.0
+Keywords: ai,luma,modify-video,runapi,sdk,video
+Requires-Python: >=3.9
+Requires-Dist: runapi-core
+Description-Content-Type: text/markdown
+
+# Luma Python SDK for RunAPI
+
+The Luma Python SDK is the language-specific package for Luma on RunAPI. Use it
+for video modification 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/luma; for API reference, use
+https://runapi.ai/docs#luma; for SDK docs, use https://runapi.ai/docs#sdk-luma.
+
+## Install
+
+```bash
+pip install runapi-luma
+```
+
+## Quick start
+
+```python
+from runapi.luma import LumaClient
+
+client = LumaClient()  # reads RUNAPI_API_KEY, or pass api_key="sk-..."
+
+task = client.modify_video.create(
+    model="ray-2-modify-video",
+    prompt="Make it cinematic with warm golden tones",
+    source_video_url="https://example.com/source.mp4",
+)
+status = client.modify_video.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.modify_video.run(
+    model="ray-2-modify-video",
+    prompt="Restyle as a hand-painted animation",
+    source_video_url="https://example.com/source.mp4",
+)
+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.luma` error classes
+when building video jobs or scripts. The available resource is `modify_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/luma
+- SDK docs: https://runapi.ai/docs#sdk-luma
+- Product docs: https://runapi.ai/docs#luma
+- Pricing and rate limits: https://runapi.ai/models/luma
+- Full catalog: https://runapi.ai/models
+
+## License
+
+Licensed under the Apache License, Version 2.0.

runapi_luma-0.1.0/README.md

@@ -0,0 +1,67 @@
+# Luma Python SDK for RunAPI
+
+The Luma Python SDK is the language-specific package for Luma on RunAPI. Use it
+for video modification 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/luma; for API reference, use
+https://runapi.ai/docs#luma; for SDK docs, use https://runapi.ai/docs#sdk-luma.
+
+## Install
+
+```bash
+pip install runapi-luma
+```
+
+## Quick start
+
+```python
+from runapi.luma import LumaClient
+
+client = LumaClient()  # reads RUNAPI_API_KEY, or pass api_key="sk-..."
+
+task = client.modify_video.create(
+    model="ray-2-modify-video",
+    prompt="Make it cinematic with warm golden tones",
+    source_video_url="https://example.com/source.mp4",
+)
+status = client.modify_video.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.modify_video.run(
+    model="ray-2-modify-video",
+    prompt="Restyle as a hand-painted animation",
+    source_video_url="https://example.com/source.mp4",
+)
+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.luma` error classes
+when building video jobs or scripts. The available resource is `modify_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/luma
+- SDK docs: https://runapi.ai/docs#sdk-luma
+- Product docs: https://runapi.ai/docs#luma
+- Pricing and rate limits: https://runapi.ai/models/luma
+- Full catalog: https://runapi.ai/models
+
+## License
+
+Licensed under the Apache License, Version 2.0.

runapi_luma-0.1.0/pyproject.toml

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

runapi_luma-0.1.0/src/runapi/luma/__init__.py

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

runapi_luma-0.1.0/src/runapi/luma/client.py

@@ -0,0 +1,28 @@
+"""Luma client."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from runapi.core import ClientOptions, HttpClient, resolve_api_key
+
+from .resources.modify_video import ModifyVideo
+
+
+class LumaClient:
+    """Luma modify-video client.
+
+    Example::
+
+        client = LumaClient(api_key="sk-...")
+        result = client.modify_video.run(
+            model="...", prompt="Make it cinematic",
+            source_video_url="https://example.com/source.mp4",
+        )
+    """
+
+    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.modify_video = ModifyVideo(http)

runapi_luma-0.1.0/src/runapi/luma/resources/__init__.py

@@ -0,0 +1,3 @@
+from .modify_video import ModifyVideo
+
+__all__ = ["ModifyVideo"]

runapi_luma-0.1.0/src/runapi/luma/resources/modify_video.py

@@ -0,0 +1,39 @@
+"""Luma modify-video resource."""
+
+from __future__ import annotations
+
+from typing import Any, Dict
+
+from runapi.core import Resource, ValidationError
+
+from ..types import CompletedModifyVideoResponse, ModifyVideoResponse
+
+
+class ModifyVideo(Resource):
+    """Modify a source video with Luma."""
+
+    ENDPOINT = "/api/v1/luma/modify_video"
+
+    RESPONSE_CLASS = ModifyVideoResponse
+    COMPLETED_RESPONSE_CLASS = CompletedModifyVideoResponse
+
+    def run(self, **params: Any) -> Any:
+        """Create a task and poll until it completes."""
+        task = self.create(**params)
+        return self._poll_until_complete(lambda: self.get(task.id))
+
+    def create(self, **params: Any) -> Any:
+        """Create a modify-video task and return immediately with an ``id``."""
+        compacted = self._compact_params(params)
+        self._validate_params(compacted)
+        return self._request("post", self.ENDPOINT, body=compacted)
+
+    def get(self, id: str) -> Any:
+        """Fetch the current status of a modify-video task."""
+        return self._request("get", f"{self.ENDPOINT}/{id}")
+
+    def _validate_params(self, params: Dict[str, Any]) -> None:
+        if not params.get("prompt"):
+            raise ValidationError("prompt is required")
+        if not params.get("source_video_url"):
+            raise ValidationError("source_video_url is required")

runapi_luma-0.1.0/src/runapi/luma/types.py

@@ -0,0 +1,30 @@
+"""Luma response models."""
+
+from __future__ import annotations
+
+from runapi.core import BaseModel, TaskResponse, optional, required
+
+
+class Video(BaseModel):
+    """A generated or source video reference."""
+
+    url = optional(str)
+
+
+class ModifyVideoResponse(TaskResponse):
+    """Response for a modify-video task."""
+
+    id = required(str)
+    status = optional(str, enum=lambda: TaskResponse.Status.ALL)
+    videos = optional([lambda: Video])
+    sources = optional([lambda: Video])
+    error = optional(str)
+
+
+class CompletedModifyVideoResponse(ModifyVideoResponse):
+    """Returned by ``modify_video.run()`` once polling observes completion.
+
+    ``videos`` is required so callers never have to null-check it on success.
+    """
+
+    videos = required([lambda: Video])

runapi_luma-0.1.0/tests/test_client.py

@@ -0,0 +1,133 @@
+import pytest
+
+from runapi.core import config
+from runapi.core.errors import AuthenticationError, ValidationError
+from runapi.luma import LumaClient
+from runapi.luma.resources.modify_video import ModifyVideo
+from runapi.luma.types import CompletedModifyVideoResponse, ModifyVideoResponse
+
+
+class FakeHttp:
+    """Records (method, path, body) and replays preset responses by call order."""
+
+    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
+
+
+# --- authentication -------------------------------------------------------
+
+
+def test_accepts_api_key_parameter():
+    assert isinstance(LumaClient(api_key="param-key", http_client=FakeHttp()), LumaClient)
+
+
+def test_falls_back_to_global(monkeypatch):
+    monkeypatch.setattr(config, "api_key", "global-key")
+    assert isinstance(LumaClient(http_client=FakeHttp()), LumaClient)
+
+
+def test_falls_back_to_env(monkeypatch):
+    monkeypatch.setenv("RUNAPI_API_KEY", "env-key")
+    assert isinstance(LumaClient(http_client=FakeHttp()), LumaClient)
+
+
+def test_raises_without_api_key():
+    with pytest.raises(AuthenticationError, match="API key is required"):
+        LumaClient()
+
+
+# --- transport injection / accessors --------------------------------------
+
+
+def test_uses_injected_http_client():
+    fake = FakeHttp()
+    client = LumaClient(api_key="k", http_client=fake)
+    assert client.modify_video._http is fake
+
+
+def test_exposes_resource_accessors():
+    client = LumaClient(api_key="k", http_client=FakeHttp())
+    assert isinstance(client.modify_video, ModifyVideo)
+
+
+# --- request shapes -------------------------------------------------------
+
+
+def test_create_posts_compacted_body():
+    fake = FakeHttp({"id": "t1", "status": "pending"})
+    client = LumaClient(api_key="k", http_client=fake)
+    result = client.modify_video.create(
+        model="ray-2-modify-video",
+        prompt="hello",
+        source_video_url="https://example.com/source.mp4",
+        callback_url=None,
+    )
+    assert fake.calls == [
+        (
+            "post",
+            "/api/v1/luma/modify_video",
+            {
+                "model": "ray-2-modify-video",
+                "prompt": "hello",
+                "source_video_url": "https://example.com/source.mp4",
+            },
+        ),
+    ]
+    assert isinstance(result, ModifyVideoResponse)
+    assert result.id == "t1"
+
+
+def test_get_fetches_by_id():
+    fake = FakeHttp({"id": "t1", "status": "processing"})
+    client = LumaClient(api_key="k", http_client=fake)
+    client.modify_video.get("t1")
+    assert fake.calls == [("get", "/api/v1/luma/modify_video/t1", None)]
+
+
+def test_run_polls_and_narrows_completed_type():
+    fake = FakeHttp(
+        {"id": "t1", "status": "pending"},
+        {
+            "id": "t1",
+            "status": "completed",
+            "videos": [{"url": "https://x/y.mp4"}],
+        },
+    )
+    client = LumaClient(api_key="k", http_client=fake)
+    result = client.modify_video.run(
+        prompt="hi",
+        source_video_url="https://example.com/source.mp4",
+    )
+
+    assert isinstance(result, CompletedModifyVideoResponse)
+    assert result.videos[0].url == "https://x/y.mp4"
+    assert [call[0] for call in fake.calls] == ["post", "get"]
+
+
+# --- validation -----------------------------------------------------------
+
+
+def test_create_requires_prompt():
+    client = LumaClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="prompt is required"):
+        client.modify_video.create(source_video_url="https://example.com/source.mp4")
+
+
+def test_create_requires_source_video_url():
+    client = LumaClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="source_video_url is required"):
+        client.modify_video.create(prompt="hi")