runapi-heygen-video 0.1.0__tar.gz

runapi_heygen_video-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 RunAPI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

runapi_heygen_video-0.1.0/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.5
+Name: runapi-heygen-video
+Version: 0.1.0
+Summary: RunAPI HeyGen Video SDK for text-to-video, reference-guided, and image-to-video workflows with generated sound in JavaScript, Python, Ruby, Go, Java, and PHP
+Project-URL: Homepage, https://runapi.ai/models/heygen-video
+Project-URL: Documentation, https://runapi.ai/docs/resources/sdks
+Project-URL: Source, https://github.com/runapi-ai/heygen-video-sdk
+Project-URL: Issues, https://github.com/runapi-ai/heygen-video-sdk/issues
+Project-URL: Changelog, https://github.com/runapi-ai/heygen-video-sdk/blob/main/CHANGELOG.md
+Project-URL: Release Notes, https://github.com/runapi-ai/heygen-video-sdk/releases/tag/python%2Fv0.1.0
+Author-email: RunAPI <contact@runapi.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: api,golang,gradle,heygen-video,image-to-video,java,maven,python,ruby,runapi,runapi-ai,sdk,text-to-video,typescript,video-generation
+Requires-Python: >=3.9
+Requires-Dist: runapi-core~=0.10.1
+Description-Content-Type: text/markdown
+
+# HeyGen Video API Python SDK for RunAPI
+
+Use `runapi-heygen-video` for HeyGen Video video tasks in Python.
+
+```bash
+pip install runapi-heygen-video
+```
+
+```python
+from runapi.heygen_video import HeyGenVideoClient
+
+client = HeyGenVideoClient()
+result = client.text_to_video.run(
+    model="heygen-video-1",
+    prompt="A cinematic tracking shot through a rain-soaked city",
+    aspect_ratio="16:9",
+)
+print(result.videos[0].url)
+```
+
+Use `text_to_video` for prompt-only or reference-media generation. Use `image_to_video` with a first-frame image. Each resource provides `create`, `get`, and `run`.
+
+- [Model reference](https://runapi.ai/models/heygen-video)
+- [API reference](https://runapi.ai/docs/api/heygen-video/text-to-video)
+- [Pricing and rate limits](https://runapi.ai/models/heygen-video)
+
+Licensed under the Apache License, Version 2.0.

runapi_heygen_video-0.1.0/README.md

@@ -0,0 +1,27 @@
+# HeyGen Video API Python SDK for RunAPI
+
+Use `runapi-heygen-video` for HeyGen Video video tasks in Python.
+
+```bash
+pip install runapi-heygen-video
+```
+
+```python
+from runapi.heygen_video import HeyGenVideoClient
+
+client = HeyGenVideoClient()
+result = client.text_to_video.run(
+    model="heygen-video-1",
+    prompt="A cinematic tracking shot through a rain-soaked city",
+    aspect_ratio="16:9",
+)
+print(result.videos[0].url)
+```
+
+Use `text_to_video` for prompt-only or reference-media generation. Use `image_to_video` with a first-frame image. Each resource provides `create`, `get`, and `run`.
+
+- [Model reference](https://runapi.ai/models/heygen-video)
+- [API reference](https://runapi.ai/docs/api/heygen-video/text-to-video)
+- [Pricing and rate limits](https://runapi.ai/models/heygen-video)
+
+Licensed under the Apache License, Version 2.0.

runapi_heygen_video-0.1.0/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "runapi-heygen-video"
+version = "0.1.0"
+description = "RunAPI HeyGen Video SDK for text-to-video, reference-guided, and image-to-video workflows with generated sound 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", "heygen-video", "api", "sdk", "typescript", "python", "ruby", "golang", "java", "maven", "gradle", "video-generation", "text-to-video", "image-to-video"]
+dependencies = ["runapi-core~=0.10.1"]
+
+[project.urls]
+Homepage = "https://runapi.ai/models/heygen-video"
+Documentation = "https://runapi.ai/docs/resources/sdks"
+Source = "https://github.com/runapi-ai/heygen-video-sdk"
+Issues = "https://github.com/runapi-ai/heygen-video-sdk/issues"
+Changelog = "https://github.com/runapi-ai/heygen-video-sdk/blob/main/CHANGELOG.md"
+"Release Notes" = "https://github.com/runapi-ai/heygen-video-sdk/releases/tag/python%2Fv0.1.0"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/runapi"]
+
+[tool.uv]
+package = true
+
+[dependency-groups]
+dev = ["pytest>=8"]
+
+[tool.runapi]
+slug = "heygen-video"

runapi_heygen_video-0.1.0/src/runapi/heygen_video/__init__.py

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

runapi_heygen_video-0.1.0/src/runapi/heygen_video/client.py

@@ -0,0 +1,28 @@
+"""HeyGen Video client."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from runapi.core import ProviderClient
+
+from .resources.image_to_video import ImageToVideo
+from .resources.text_to_video import TextToVideo
+
+
+class HeyGenVideoClient(ProviderClient):
+    """HeyGen Video text-to-video and image-to-video client.
+
+    Example::
+
+        client = HeyGenVideoClient(api_key="sk-...")
+        result = client.text_to_video.run(
+            model="heygen-video-1", prompt="A neon city street"
+        )
+    """
+
+    def __init__(self, api_key: Optional[str] = None, **options: Any) -> None:
+        super().__init__(api_key, **options)
+        http = self._http
+        self.text_to_video = TextToVideo(http)
+        self.image_to_video = ImageToVideo(http)

runapi_heygen_video-0.1.0/src/runapi/heygen_video/resources/__init__.py

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

runapi_heygen_video-0.1.0/src/runapi/heygen_video/resources/image_to_video.py

@@ -0,0 +1,56 @@
+"""HeyGen Video image-to-video resource."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from runapi.core import Resource, RequestOptions
+
+from ..types import (
+    CompletedVideoTaskResponse,
+    VideoTaskResponse,
+)
+
+
+class ImageToVideo(Resource):
+    """Generate videos from a source image with HeyGen Video models."""
+
+    ENDPOINT = "/api/v1/heygen_video/image_to_video"
+
+    RESPONSE_CLASS = VideoTaskResponse
+    COMPLETED_RESPONSE_CLASS = CompletedVideoTaskResponse
+
+    def run(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        """Create an image-to-video task and poll until it completes.
+
+        Args:
+            **params: Image-to-video parameters (model, prompt, ...).
+
+        Returns:
+            The completed task with videos.
+        """
+        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 an image-to-video task and return immediately with an ``id``.
+
+        Args:
+            **params: Image-to-video parameters (model, prompt, ...).
+
+        Returns:
+            The task creation result with an id.
+        """
+        compacted = self._compact_params(params)
+        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 an image-to-video task.
+
+        Args:
+            id: The task id.
+
+        Returns:
+            The current task status.
+        """
+        return self._request("get", f"{self.ENDPOINT}/{id}", options=options)

runapi_heygen_video-0.1.0/src/runapi/heygen_video/resources/text_to_video.py

@@ -0,0 +1,56 @@
+"""HeyGen Video text-to-video resource."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from runapi.core import Resource, RequestOptions
+
+from ..types import (
+    CompletedVideoTaskResponse,
+    VideoTaskResponse,
+)
+
+
+class TextToVideo(Resource):
+    """Generate videos from text prompts with HeyGen Video models."""
+
+    ENDPOINT = "/api/v1/heygen_video/text_to_video"
+
+    RESPONSE_CLASS = VideoTaskResponse
+    COMPLETED_RESPONSE_CLASS = CompletedVideoTaskResponse
+
+    def run(self, options: Optional[RequestOptions] = None, **params: Any) -> Any:
+        """Create a text-to-video task and poll until it completes.
+
+        Args:
+            **params: Text-to-video parameters (model, prompt, ...).
+
+        Returns:
+            The completed task with videos.
+        """
+        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 text-to-video task and return immediately with an ``id``.
+
+        Args:
+            **params: Text-to-video parameters (model, prompt, ...).
+
+        Returns:
+            The task creation result with an id.
+        """
+        compacted = self._compact_params(params)
+        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 text-to-video task.
+
+        Args:
+            id: The task id.
+
+        Returns:
+            The current task status.
+        """
+        return self._request("get", f"{self.ENDPOINT}/{id}", options=options)

runapi_heygen_video-0.1.0/src/runapi/heygen_video/types.py

@@ -0,0 +1,24 @@
+"""HeyGen Video model lists, enums, and response models."""
+
+from __future__ import annotations
+
+from runapi.core import BaseModel, TaskResponse, optional, required
+
+
+class MediaUrl(BaseModel):
+    url = optional(str)
+
+
+class VideoTaskResponse(TaskResponse):
+    """Response for a video generation task."""
+
+    id = required(str)
+    status = optional(str, enum=lambda: TaskResponse.Status.ALL)
+    videos = optional([lambda: MediaUrl])
+    error = optional(str)
+
+
+class CompletedVideoTaskResponse(VideoTaskResponse):
+    """Narrowed response from ``run()`` once polling observes completion."""
+
+    videos = required([lambda: MediaUrl])

runapi_heygen_video-0.1.0/tests/test_client.py

@@ -0,0 +1,47 @@
+from runapi.heygen_video import HeyGenVideoClient
+
+
+class FakeHttp:
+    def __init__(self, response=None):
+        self.response = response or {"id": "task_1", "status": "pending"}
+        self.calls = []
+
+    def request(self, method, path, body=None, options=None):
+        self.calls.append((method, path, body))
+        return self.response
+
+
+def test_posts_reference_media_through_text_to_video():
+    fake = FakeHttp()
+    client = HeyGenVideoClient(api_key="k", http_client=fake)
+    client.text_to_video.create(
+        model="heygen-video-1",
+        prompt="Continue the performance",
+        reference_image_urls=["https://cdn.runapi.ai/public/samples/image.jpg"],
+        reference_audio_urls=["https://cdn.runapi.ai/public/samples/voice.mp3"],
+        aspect_ratio="adaptive",
+    )
+    assert fake.calls == [("post", "/api/v1/heygen_video/text_to_video", {
+        "model": "heygen-video-1",
+        "prompt": "Continue the performance",
+        "reference_image_urls": ["https://cdn.runapi.ai/public/samples/image.jpg"],
+        "reference_audio_urls": ["https://cdn.runapi.ai/public/samples/voice.mp3"],
+        "aspect_ratio": "adaptive",
+    })]
+
+
+def test_posts_first_frame_and_seed_through_image_to_video():
+    fake = FakeHttp()
+    client = HeyGenVideoClient(api_key="k", http_client=fake)
+    client.image_to_video.create(
+        model="heygen-video-1",
+        prompt="Animate",
+        first_frame_image_url="https://cdn.runapi.ai/public/samples/image.jpg",
+        seed=42,
+    )
+    assert fake.calls == [("post", "/api/v1/heygen_video/image_to_video", {
+        "model": "heygen-video-1",
+        "prompt": "Animate",
+        "first_frame_image_url": "https://cdn.runapi.ai/public/samples/image.jpg",
+        "seed": 42,
+    })]