runapi-volcengine-lip-sync 0.1.1__tar.gz

runapi_volcengine_lip_sync-0.1.1/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: runapi-volcengine-lip-sync
+Version: 0.1.1
+Summary: RunAPI Volcengine Lip Sync SDK for audio-driven video-to-video lip sync workflows in JavaScript, Python, Ruby, Go, Java, and PHP
+Project-URL: Homepage, https://runapi.ai/models/volcengine-lip-sync
+Project-URL: Documentation, https://runapi.ai/docs#sdk-volcengine-lip-sync
+Project-URL: Source, https://github.com/runapi-ai/volcengine-lip-sync-sdk
+Project-URL: Issues, https://github.com/runapi-ai/volcengine-lip-sync-sdk/issues
+Author-email: RunAPI <contact@runapi.ai>
+License-Expression: Apache-2.0
+Keywords: api,golang,gradle,java,lip-sync,lip-sync-api,maven,python,ruby,runapi,runapi-ai,sdk,typescript,video-api,video-generation,volcengine
+Requires-Python: >=3.9
+Requires-Dist: runapi-core>=0.1.4
+Description-Content-Type: text/markdown
+
+# Volcengine Lip Sync API Python SDK for RunAPI
+
+The Volcengine Lip Sync Python SDK submits lip-sync video tasks and retrieves task results through RunAPI.
+
+## Install
+
+```bash
+pip install runapi-volcengine-lip-sync
+```
+
+## Quick start
+
+```python
+from runapi.volcengine_lip_sync import VolcengineLipSyncClient
+
+client = VolcengineLipSyncClient()
+task = client.lip_sync_video.create(
+    model="volcengine-lip-sync",
+    mode="lite",
+    source_video_url="https://cdn.runapi.ai/public/samples/volcengine-lip-sync-source.mp4",
+    source_audio_url="https://cdn.runapi.ai/public/samples/volcengine-lip-sync-voice-adam.mp3",
+)
+status = client.lip_sync_video.get(task.id)
+```
+
+Use `create`, `get`, and `run` for async workflows. Keep `RUNAPI_API_KEY` in the environment or your secret manager.
+
+## Links
+
+- Model page: https://runapi.ai/models/volcengine-lip-sync
+- SDK docs: https://runapi.ai/docs#sdk-volcengine-lip-sync
+- Product docs: https://runapi.ai/docs#volcengine-lip-sync
+- Pricing and rate limits: https://runapi.ai/models/volcengine-lip-sync
+- Repository: https://github.com/runapi-ai/volcengine-lip-sync-sdk
+
+## License
+
+Licensed under the Apache License, Version 2.0.

runapi_volcengine_lip_sync-0.1.1/README.md

@@ -0,0 +1,38 @@
+# Volcengine Lip Sync API Python SDK for RunAPI
+
+The Volcengine Lip Sync Python SDK submits lip-sync video tasks and retrieves task results through RunAPI.
+
+## Install
+
+```bash
+pip install runapi-volcengine-lip-sync
+```
+
+## Quick start
+
+```python
+from runapi.volcengine_lip_sync import VolcengineLipSyncClient
+
+client = VolcengineLipSyncClient()
+task = client.lip_sync_video.create(
+    model="volcengine-lip-sync",
+    mode="lite",
+    source_video_url="https://cdn.runapi.ai/public/samples/volcengine-lip-sync-source.mp4",
+    source_audio_url="https://cdn.runapi.ai/public/samples/volcengine-lip-sync-voice-adam.mp3",
+)
+status = client.lip_sync_video.get(task.id)
+```
+
+Use `create`, `get`, and `run` for async workflows. Keep `RUNAPI_API_KEY` in the environment or your secret manager.
+
+## Links
+
+- Model page: https://runapi.ai/models/volcengine-lip-sync
+- SDK docs: https://runapi.ai/docs#sdk-volcengine-lip-sync
+- Product docs: https://runapi.ai/docs#volcengine-lip-sync
+- Pricing and rate limits: https://runapi.ai/models/volcengine-lip-sync
+- Repository: https://github.com/runapi-ai/volcengine-lip-sync-sdk
+
+## License
+
+Licensed under the Apache License, Version 2.0.

runapi_volcengine_lip_sync-0.1.1/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "runapi-volcengine-lip-sync"
+version = "0.1.1"
+description = "RunAPI Volcengine Lip Sync SDK for audio-driven video-to-video lip sync workflows in JavaScript, Python, Ruby, Go, Java, and PHP"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "Apache-2.0"
+authors = [{ name = "RunAPI", email = "contact@runapi.ai" }]
+keywords = ["runapi", "runapi-ai", "volcengine", "lip-sync", "api", "sdk", "typescript", "python", "ruby", "golang", "java", "maven", "gradle", "video-generation", "video-api", "lip-sync-api"]
+dependencies = ["runapi-core>=0.1.4"]
+
+[project.urls]
+Homepage = "https://runapi.ai/models/volcengine-lip-sync"
+Documentation = "https://runapi.ai/docs#sdk-volcengine-lip-sync"
+Source = "https://github.com/runapi-ai/volcengine-lip-sync-sdk"
+Issues = "https://github.com/runapi-ai/volcengine-lip-sync-sdk/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/runapi"]
+
+[tool.uv]
+package = true
+
+[dependency-groups]
+dev = ["pytest>=8"]
+
+[tool.runapi]
+slug = "volcengine-lip-sync"

runapi_volcengine_lip_sync-0.1.1/src/runapi/volcengine_lip_sync/__init__.py

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

runapi_volcengine_lip_sync-0.1.1/src/runapi/volcengine_lip_sync/client.py

@@ -0,0 +1,19 @@
+"""Volcengine Lip Sync client."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from runapi.core import ClientOptions, HttpClient, resolve_api_key
+
+from .resources.lip_sync_video import LipSyncVideo
+
+
+class VolcengineLipSyncClient:
+    """Volcengine Lip Sync client."""
+
+    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.lip_sync_video = LipSyncVideo(http)

runapi_volcengine_lip_sync-0.1.1/src/runapi/volcengine_lip_sync/contract_gen.py

@@ -0,0 +1,38 @@
+CONTRACT = {
+    "lip-sync-video": {
+        "models": ["volcengine-lip-sync"],
+        "fields_by_model": {
+            "volcengine-lip-sync": {
+                "mode": {
+                    "enum": ["lite", "basic"],
+                    "required": True
+                },
+                "source_audio_url": {
+                    "required": True
+                },
+                "source_video_url": {
+                    "required": True
+                },
+                "template_start_seconds": {
+                    "min": 0
+                }
+            }
+        },
+        "rules": [{
+            "when": {
+                "mode": "lite"
+            },
+            "forbidden": ["enable_scene_detection"]
+        }, {
+            "when": {
+                "mode": "basic"
+            },
+            "forbidden": ["align_audio", "align_audio_reverse", "template_start_seconds"]
+        }, {
+            "when": {
+                "align_audio_reverse": True
+            },
+            "required": ["align_audio"]
+        }]
+    }
+}

runapi_volcengine_lip_sync-0.1.1/src/runapi/volcengine_lip_sync/py.typed

@@ -0,0 +1 @@
+

runapi_volcengine_lip_sync-0.1.1/src/runapi/volcengine_lip_sync/resources/__init__.py

@@ -0,0 +1,3 @@
+from .lip_sync_video import LipSyncVideo
+
+__all__ = ["LipSyncVideo"]

runapi_volcengine_lip_sync-0.1.1/src/runapi/volcengine_lip_sync/resources/lip_sync_video.py

@@ -0,0 +1,34 @@
+"""Volcengine Lip Sync video resource."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from runapi.core import Resource, RequestOptions
+
+from ..contract_gen import CONTRACT
+from ..types import CompletedLipSyncVideoResponse, LipSyncVideoResponse
+
+
+class LipSyncVideo(Resource):
+    """Drive a source video's lip movement from an audio track."""
+
+    ENDPOINT = "/api/v1/volcengine_lip_sync/lip_sync_video"
+
+    RESPONSE_CLASS = LipSyncVideoResponse
+    COMPLETED_RESPONSE_CLASS = CompletedLipSyncVideoResponse
+
+    def run(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        """Create a task and poll until it completes."""
+        task = self.create(options=options, **params)
+        return self._poll_until_complete(lambda: self.get(task.id, options=options))
+
+    def create(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        """Create a lip-sync video task and return immediately with an ``id``."""
+        compacted = self._compact_params(params)
+        self._validate_contract(CONTRACT["lip-sync-video"], compacted)
+        return self._request("post", self.ENDPOINT, body=compacted, options=options)
+
+    def get(self, id: str, options: Optional[RequestOptions] = None) -> Any:
+        """Fetch the current status of a lip-sync video task."""
+        return self._request("get", f"{self.ENDPOINT}/{id}", options=options)

runapi_volcengine_lip_sync-0.1.1/src/runapi/volcengine_lip_sync/types.py

@@ -0,0 +1,26 @@
+"""Volcengine Lip Sync response models."""
+
+from __future__ import annotations
+
+from runapi.core import BaseModel, TaskResponse, optional, required
+
+
+class Video(BaseModel):
+    """A generated video reference."""
+
+    url = optional(str)
+
+
+class LipSyncVideoResponse(TaskResponse):
+    """Response for a lip-sync video task."""
+
+    id = required(str)
+    status = optional(str, enum=lambda: TaskResponse.Status.ALL)
+    videos = optional([lambda: Video])
+    error = optional(str)
+
+
+class CompletedLipSyncVideoResponse(LipSyncVideoResponse):
+    """Returned by ``lip_sync_video.run()`` once polling observes completion."""
+
+    videos = required([lambda: Video])

runapi_volcengine_lip_sync-0.1.1/tests/test_client.py

@@ -0,0 +1,135 @@
+import pytest
+
+from runapi.core import config
+from runapi.core.errors import AuthenticationError, ValidationError
+from runapi.volcengine_lip_sync import VolcengineLipSyncClient
+from runapi.volcengine_lip_sync.resources.lip_sync_video import LipSyncVideo
+from runapi.volcengine_lip_sync.types import CompletedLipSyncVideoResponse, LipSyncVideoResponse
+
+
+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
+
+
+def test_accepts_api_key_parameter():
+    assert isinstance(VolcengineLipSyncClient(api_key="param-key", http_client=FakeHttp()), VolcengineLipSyncClient)
+
+
+def test_falls_back_to_global(monkeypatch):
+    monkeypatch.setattr(config, "api_key", "global-key")
+    assert isinstance(VolcengineLipSyncClient(http_client=FakeHttp()), VolcengineLipSyncClient)
+
+
+def test_falls_back_to_env(monkeypatch):
+    monkeypatch.setenv("RUNAPI_API_KEY", "env-key")
+    assert isinstance(VolcengineLipSyncClient(http_client=FakeHttp()), VolcengineLipSyncClient)
+
+
+def test_raises_without_api_key():
+    with pytest.raises(AuthenticationError, match="API key is required"):
+        VolcengineLipSyncClient()
+
+
+def test_uses_injected_http_client():
+    fake = FakeHttp()
+    client = VolcengineLipSyncClient(api_key="k", http_client=fake)
+    assert client.lip_sync_video._http is fake
+
+
+def test_exposes_resource_accessors():
+    client = VolcengineLipSyncClient(api_key="k", http_client=FakeHttp())
+    assert isinstance(client.lip_sync_video, LipSyncVideo)
+
+
+def test_create_posts_compacted_body():
+    fake = FakeHttp({"id": "t1", "status": "pending"})
+    client = VolcengineLipSyncClient(api_key="k", http_client=fake)
+    result = client.lip_sync_video.create(
+        model="volcengine-lip-sync",
+        mode="lite",
+        source_video_url="https://cdn.runapi.ai/public/samples/volcengine-lip-sync-source.mp4",
+        source_audio_url="https://cdn.runapi.ai/public/samples/volcengine-lip-sync-voice-adam.mp3",
+        callback_url=None,
+        enable_vocal_separation=False,
+    )
+    assert fake.calls == [
+        (
+            "post",
+            "/api/v1/volcengine_lip_sync/lip_sync_video",
+            {
+                "model": "volcengine-lip-sync",
+                "mode": "lite",
+                "source_video_url": "https://cdn.runapi.ai/public/samples/volcengine-lip-sync-source.mp4",
+                "source_audio_url": "https://cdn.runapi.ai/public/samples/volcengine-lip-sync-voice-adam.mp3",
+                "enable_vocal_separation": False,
+            },
+        ),
+    ]
+    assert isinstance(result, LipSyncVideoResponse)
+    assert result.id == "t1"
+
+
+def test_get_fetches_by_id():
+    fake = FakeHttp({"id": "t1", "status": "processing"})
+    client = VolcengineLipSyncClient(api_key="k", http_client=fake)
+    client.lip_sync_video.get("t1")
+    assert fake.calls == [("get", "/api/v1/volcengine_lip_sync/lip_sync_video/t1", None)]
+
+
+def test_run_polls_and_narrows_completed_type():
+    fake = FakeHttp(
+        {"id": "t1", "status": "pending"},
+        {
+            "id": "t1",
+            "status": "completed",
+            "videos": [{"url": "https://cdn.runapi.ai/public/samples/volcengine-lip-sync-result-adam.mp4"}],
+        },
+    )
+    client = VolcengineLipSyncClient(api_key="k", http_client=fake)
+    result = client.lip_sync_video.run(
+        model="volcengine-lip-sync",
+        mode="lite",
+        source_video_url="https://cdn.runapi.ai/public/samples/volcengine-lip-sync-source.mp4",
+        source_audio_url="https://cdn.runapi.ai/public/samples/volcengine-lip-sync-voice-adam.mp3",
+    )
+
+    assert isinstance(result, CompletedLipSyncVideoResponse)
+    assert result.videos[0].url == "https://cdn.runapi.ai/public/samples/volcengine-lip-sync-result-adam.mp4"
+    assert [call[0] for call in fake.calls] == ["post", "get"]
+
+
+def test_create_requires_model():
+    client = VolcengineLipSyncClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="model must be one of: volcengine-lip-sync"):
+        client.lip_sync_video.create(
+            mode="lite",
+            source_video_url="https://cdn.runapi.ai/public/samples/volcengine-lip-sync-source.mp4",
+            source_audio_url="https://cdn.runapi.ai/public/samples/volcengine-lip-sync-voice-adam.mp3",
+        )
+
+
+def test_create_requires_source_audio_url():
+    client = VolcengineLipSyncClient(api_key="k", http_client=FakeHttp())
+    with pytest.raises(ValidationError, match="source_audio_url is required"):
+        client.lip_sync_video.create(
+            model="volcengine-lip-sync",
+            mode="lite",
+            source_video_url="https://cdn.runapi.ai/public/samples/volcengine-lip-sync-source.mp4",
+        )