magic_hour 0.8.1__tar.gz → 0.8.3__tar.gz

{magic_hour-0.8.1 → magic_hour-0.8.3}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: magic_hour
-Version: 0.8.1
-Summary: 
+Version: 0.8.3
+Summary: Python SDK for Magic Hour API
 Requires-Python: >=3.8,<4.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
@@ -16,52 +16,47 @@ Requires-Dist: pydantic (>=2.5.0,<3.0.0)
 Requires-Dist: typing_extensions (>=4.0.0,<5.0.0)
 Description-Content-Type: text/markdown
 
+# Magic Hour Python SDK
 
-# Magic Hour API Python SDK
+[![PyPI - Version](https://img.shields.io/pypi/v/magic_hour)](https://pypi.org/project/magic_hour/)
 
-## Overview
-
-# Introduction 
-
-Magic Hour provides an API (beta) that can be integrated into your own application to generate videos using AI. 
+Magic Hour provides an API (beta) that can be integrated into your own application to generate videos and images using AI.
 
 Webhook documentation can be found [here](https://magichour.ai/docs/webhook).
 
 If you have any questions, please reach out to us via [discord](https://discord.gg/JX5rgsZaJp).
 
-# Authentication
-
-Every request requires an API key.
-
-To get started, first generate your API key [here](https://magichour.ai/settings/developer).
+## Install
 
-Then, add the `Authorization` header to the request.
-
-| Key | Value |
-|-|-|
-| Authorization | Bearer mhk_live_apikey |
+```
+pip install magic_hour
+```
 
-> **Warning**: any API call that renders a video will utilize frames in your account.
+## Usage
 
+Initialize the client
 
 ### Synchronous Client
 
 ```python
 from magic_hour import Client
-from os import getenv
 
-client = Client(token=getenv("API_TOKEN"))
+# generate your API Key at https://magichour.ai/developer
+client = Client(token="my api key")
 ```
 
 ### Asynchronous Client
 
 ```python
 from magic_hour import AsyncClient
-from os import getenv
 
-client = AsyncClient(token=getenv("API_TOKEN"))
+# generate your API Key at https://magichour.ai/developer
+client = AsyncClient(token="my api key")
 ```
 
+> [!WARNING]
+> Any API call that renders a video will utilize frames in your account.
+
 ## Module Documentation and Snippets
 
 ### [v1.ai_clothes_changer](magic_hour/resources/v1/ai_clothes_changer/README.md)

{magic_hour-0.8.1 → magic_hour-0.8.3}/README.md

@@ -1,49 +1,44 @@
+# Magic Hour Python SDK
 
-# Magic Hour API Python SDK
+[![PyPI - Version](https://img.shields.io/pypi/v/magic_hour)](https://pypi.org/project/magic_hour/)
 
-## Overview
-
-# Introduction 
-
-Magic Hour provides an API (beta) that can be integrated into your own application to generate videos using AI. 
+Magic Hour provides an API (beta) that can be integrated into your own application to generate videos and images using AI.
 
 Webhook documentation can be found [here](https://magichour.ai/docs/webhook).
 
 If you have any questions, please reach out to us via [discord](https://discord.gg/JX5rgsZaJp).
 
-# Authentication
-
-Every request requires an API key.
-
-To get started, first generate your API key [here](https://magichour.ai/settings/developer).
+## Install
 
-Then, add the `Authorization` header to the request.
-
-| Key | Value |
-|-|-|
-| Authorization | Bearer mhk_live_apikey |
+```
+pip install magic_hour
+```
 
-> **Warning**: any API call that renders a video will utilize frames in your account.
+## Usage
 
+Initialize the client
 
 ### Synchronous Client
 
 ```python
 from magic_hour import Client
-from os import getenv
 
-client = Client(token=getenv("API_TOKEN"))
+# generate your API Key at https://magichour.ai/developer
+client = Client(token="my api key")
 ```
 
 ### Asynchronous Client
 
 ```python
 from magic_hour import AsyncClient
-from os import getenv
 
-client = AsyncClient(token=getenv("API_TOKEN"))
+# generate your API Key at https://magichour.ai/developer
+client = AsyncClient(token="my api key")
 ```
 
+> [!WARNING]
+> Any API call that renders a video will utilize frames in your account.
+
 ## Module Documentation and Snippets
 
 ### [v1.ai_clothes_changer](magic_hour/resources/v1/ai_clothes_changer/README.md)

{magic_hour-0.8.1 → magic_hour-0.8.3}/magic_hour/core/api_error.py

@@ -1,4 +1,10 @@
+"""
+Generated by Sideko (sideko.dev)
+"""
+
+from json import JSONDecodeError
 import typing
+import httpx
 
 
 class ApiError(Exception):
@@ -13,29 +19,31 @@ class ApiError(Exception):
             None if no status code is applicable.
         body: The response body or error message content.
             Can be any type depending on the API response format.
+        response: The raw httpx response object. See https://www.python-httpx.org/api/#response for object reference
     """
 
     status_code: typing.Optional[int]
     body: typing.Any
+    response: httpx.Response
 
-    def __init__(
-        self, *, status_code: typing.Optional[int] = None, body: typing.Any = None
-    ) -> None:
+    def __init__(self, *, response: httpx.Response) -> None:
         """
         Initialize the ApiError with optional status code and body.
 
         Args:
             status_code: The HTTP status code of the error.
                 Defaults to None.
-            body: The response body or error message content.
-                Defaults to None.
 
         Note:
             The asterisk (*) in the parameters forces keyword arguments,
             making the instantiation more explicit.
         """
-        self.status_code = status_code
-        self.body = body
+        try:
+            self.body = response.json()
+        except JSONDecodeError:
+            self.body = None
+        self.status_code = response.status_code
+        self.response = response
 
     def __str__(self) -> str:
         """

{magic_hour-0.8.1 → magic_hour-0.8.3}/magic_hour/core/base_client.py

@@ -1,4 +1,3 @@
-from json import JSONDecodeError
 from typing import (
     Any,
     List,
@@ -9,6 +8,7 @@ from typing import (
     Union,
     cast,
 )
+from typing_extensions import TypeGuard
 
 import httpx
 from pydantic import BaseModel
@@ -17,7 +17,7 @@ from .api_error import ApiError
 from .auth import AuthProvider
 from .request import RequestConfig, RequestOptions, default_request_options, QueryParams
 from .response import from_encodable, AsyncStreamResponse, StreamResponse
-from .utils import is_binary_content_type, get_content_type
+from .utils import get_response_type, filter_binary_response
 from .binary_response import BinaryResponse
 
 NoneType = type(None)
@@ -96,6 +96,15 @@ class BaseClient:
 
         return f"{base}/{path}"
 
+    def _cast_to_raw_response(
+        self, res: httpx.Response, cast_to: Union[Type[T], Any]
+    ) -> TypeGuard[T]:
+        """Determines if the provided cast_to is an httpx.Response"""
+        try:
+            return issubclass(cast_to, httpx.Response)
+        except TypeError:
+            return False
+
     def _apply_auth(
         self, *, cfg: RequestConfig, auth_names: List[str]
     ) -> RequestConfig:
@@ -307,35 +316,30 @@ class BaseClient:
         Raises:
             ApiError: If the response indicates an error
         """
-        if 200 <= response.status_code < 300:
-            content_type = get_content_type(response.headers)
-            if response.status_code == 204 or cast_to == NoneType:
-                return cast(T, None)
-            elif cast_to == BinaryResponse:
-                return cast(
-                    T,
-                    BinaryResponse(content=response.content, headers=response.headers),
-                )
-            else:
-                if "json" in content_type or "form" in content_type:
-                    if cast_to is type(Any):
-                        return response.json()
-                    return from_encodable(data=response.json(), load_with=cast_to)
-                elif is_binary_content_type(content_type):
-                    return cast(
-                        T,
-                        BinaryResponse(
-                            content=response.content, headers=response.headers
-                        ),
-                    )
-                else:
-                    return from_encodable(data=response.content, load_with=cast_to)
+
+        if response.status_code == 204 or cast_to == NoneType:
+            return cast(T, None)
+        elif cast_to == BinaryResponse:
+            return cast(
+                T,
+                BinaryResponse(content=response.content, headers=response.headers),
+            )
+
+        response_type = get_response_type(response.headers)
+
+        if response_type == "json":
+            if cast_to is type(Any):
+                return response.json()
+            return from_encodable(
+                data=response.json(), load_with=filter_binary_response(cast_to=cast_to)
+            )
+        elif response_type == "text":
+            return cast(T, response.text)
         else:
-            try:
-                response_json = response.json()
-            except JSONDecodeError:
-                raise ApiError(status_code=response.status_code, body=response.text)
-            raise ApiError(status_code=response.status_code, body=response_json)
+            return cast(
+                T,
+                BinaryResponse(content=response.content, headers=response.headers),
+            )
 
 
 class SyncBaseClient(BaseClient):
@@ -411,6 +415,13 @@ class SyncBaseClient(BaseClient):
             request_options=request_options,
         )
         response = self.httpx_client.request(**req_cfg)
+
+        if not response.is_success:
+            raise ApiError(response=response)
+
+        if self._cast_to_raw_response(res=response, cast_to=cast_to):
+            return response
+
         return self.process_response(response=response, cast_to=cast_to)
 
     def stream_request(
@@ -542,6 +553,13 @@ class AsyncBaseClient(BaseClient):
             request_options=request_options,
         )
         response = await self.httpx_client.request(**req_cfg)
+
+        if not response.is_success:
+            raise ApiError(response=response)
+
+        if self._cast_to_raw_response(res=response, cast_to=cast_to):
+            return response
+
         return self.process_response(response=response, cast_to=cast_to)
 
     async def stream_request(

magic_hour-0.8.3/magic_hour/core/utils.py

@@ -0,0 +1,55 @@
+import typing
+import re
+from typing_extensions import Literal
+
+import httpx
+
+from .binary_response import BinaryResponse
+
+
+def remove_none_from_dict(
+    original: typing.Dict[str, typing.Optional[typing.Any]],
+) -> typing.Dict[str, typing.Any]:
+    new: typing.Dict[str, typing.Any] = {}
+    for key, value in original.items():
+        if value is not None:
+            new[key] = value
+    return new
+
+
+def get_response_type(headers: httpx.Headers) -> Literal["json", "text", "binary"]:
+    """Check response type based on content type"""
+    content_type = headers.get("content-type")
+
+    if re.search("^application/(.+\+)?json", content_type):
+        return "json"
+    elif re.search("^text/(.+)", content_type):
+        return "text"
+    else:
+        return "binary"
+
+
+def is_union_type(type_hint: typing.Any) -> bool:
+    """Check if a type hint is a Union type."""
+    return hasattr(type_hint, "__origin__") and type_hint.__origin__ is typing.Union
+
+
+def filter_binary_response(cast_to: typing.Type) -> typing.Type:
+    """
+    Filters out BinaryResponse from a Union type.
+    If cast_to is not a Union, returns it unchanged.
+    """
+    if not is_union_type(cast_to):
+        return cast_to
+
+    types = typing.get_args(cast_to)
+    filtered = tuple(t for t in types if t != BinaryResponse)
+
+    # If everything was filtered out, return original type
+    if not filtered:
+        return cast_to
+    # If only one type remains, return it directly
+    if len(filtered) == 1:
+        return typing.cast(typing.Type, filtered[0])
+    # Otherwise return new Union with filtered types
+    return typing.cast(typing.Type, typing.Union[filtered])  # type: ignore

{magic_hour-0.8.1 → magic_hour-0.8.3}/magic_hour/environment.py

@@ -3,4 +3,4 @@ import enum
 
 class Environment(enum.Enum):
     ENVIRONMENT = "https://api.magichour.ai"
-    MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.8.1"
+    MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.8.3"

{magic_hour-0.8.1 → magic_hour-0.8.3}/magic_hour/resources/v1/animation/README.md

@@ -19,8 +19,8 @@ res = client.v1.animation.create(
         "audio_source": "file",
         "image_file_path": "api-assets/id/1234.png",
     },
-    end_seconds=15,
-    fps=12,
+    end_seconds=15.0,
+    fps=12.0,
     height=960,
     style={
         "art_style": "Painterly Illustration",
@@ -47,8 +47,8 @@ res = await client.v1.animation.create(
         "audio_source": "file",
         "image_file_path": "api-assets/id/1234.png",
     },
-    end_seconds=15,
-    fps=12,
+    end_seconds=15.0,
+    fps=12.0,
     height=960,
     style={
         "art_style": "Painterly Illustration",

{magic_hour-0.8.1 → magic_hour-0.8.3}/magic_hour/resources/v1/animation/client.py

@@ -57,8 +57,8 @@ class AnimationClient:
         ```py
         client.v1.animation.create(
             assets={"audio_source": "file"},
-            end_seconds=15,
-            fps=12,
+            end_seconds=15.0,
+            fps=12.0,
             height=960,
             style={
                 "art_style": "Painterly Illustration",
@@ -141,8 +141,8 @@ class AsyncAnimationClient:
         ```py
         await client.v1.animation.create(
             assets={"audio_source": "file"},
-            end_seconds=15,
-            fps=12,
+            end_seconds=15.0,
+            fps=12.0,
             height=960,
             style={
                 "art_style": "Painterly Illustration",

{magic_hour-0.8.1 → magic_hour-0.8.3}/magic_hour/resources/v1/face_swap/README.md

@@ -22,9 +22,9 @@ res = client.v1.face_swap.create(
         "video_file_path": "video/id/1234.mp4",
         "video_source": "file",
     },
-    end_seconds=15,
+    end_seconds=15.0,
     height=960,
-    start_seconds=0,
+    start_seconds=0.0,
     width=512,
     name="Face Swap video",
 )
@@ -43,9 +43,9 @@ res = await client.v1.face_swap.create(
         "video_file_path": "video/id/1234.mp4",
         "video_source": "file",
     },
-    end_seconds=15,
+    end_seconds=15.0,
     height=960,
-    start_seconds=0,
+    start_seconds=0.0,
     width=512,
     name="Face Swap video",
 )

{magic_hour-0.8.1 → magic_hour-0.8.3}/magic_hour/resources/v1/face_swap/client.py

@@ -58,9 +58,9 @@ class FaceSwapClient:
         ```py
         client.v1.face_swap.create(
             assets={"image_file_path": "image/id/1234.png", "video_source": "file"},
-            end_seconds=15,
+            end_seconds=15.0,
             height=960,
-            start_seconds=0,
+            start_seconds=0.0,
             width=512,
             name="Face Swap video",
         )
@@ -135,9 +135,9 @@ class AsyncFaceSwapClient:
         ```py
         await client.v1.face_swap.create(
             assets={"image_file_path": "image/id/1234.png", "video_source": "file"},
-            end_seconds=15,
+            end_seconds=15.0,
             height=960,
-            start_seconds=0,
+            start_seconds=0.0,
             width=512,
             name="Face Swap video",
         )

{magic_hour-0.8.1 → magic_hour-0.8.3}/magic_hour/resources/v1/image_projects/README.md

@@ -13,7 +13,7 @@ from magic_hour import Client
 from os import getenv
 
 client = Client(token=getenv("API_TOKEN"))
-res = client.v1.image_projects.delete(id="string")
+res = client.v1.image_projects.delete(id="cm6pvghix03bvyz0zwash6noj")
 ```
 
 #### Asynchronous Client
@@ -23,7 +23,7 @@ from magic_hour import AsyncClient
 from os import getenv
 
 client = AsyncClient(token=getenv("API_TOKEN"))
-res = await client.v1.image_projects.delete(id="string")
+res = await client.v1.image_projects.delete(id="cm6pvghix03bvyz0zwash6noj")
 ```
 
 ### get <a name="get"></a>
@@ -49,7 +49,7 @@ from magic_hour import Client
 from os import getenv
 
 client = Client(token=getenv("API_TOKEN"))
-res = client.v1.image_projects.get(id="string")
+res = client.v1.image_projects.get(id="cm6pvghix03bvyz0zwash6noj")
 ```
 
 #### Asynchronous Client
@@ -59,5 +59,5 @@ from magic_hour import AsyncClient
 from os import getenv
 
 client = AsyncClient(token=getenv("API_TOKEN"))
-res = await client.v1.image_projects.get(id="string")
+res = await client.v1.image_projects.get(id="cm6pvghix03bvyz0zwash6noj")
 ```

{magic_hour-0.8.1 → magic_hour-0.8.3}/magic_hour/resources/v1/image_projects/client.py

@@ -36,7 +36,7 @@ class ImageProjectsClient:
 
         Examples:
         ```py
-        client.v1.image_projects.delete(id="string")
+        client.v1.image_projects.delete(id="cm6pvghix03bvyz0zwash6noj")
         ```
 
         """
@@ -80,7 +80,7 @@ class ImageProjectsClient:
 
         Examples:
         ```py
-        client.v1.image_projects.get(id="string")
+        client.v1.image_projects.get(id="cm6pvghix03bvyz0zwash6noj")
         ```
 
         """
@@ -120,7 +120,7 @@ class AsyncImageProjectsClient:
 
         Examples:
         ```py
-        await client.v1.image_projects.delete(id="string")
+        await client.v1.image_projects.delete(id="cm6pvghix03bvyz0zwash6noj")
         ```
 
         """
@@ -164,7 +164,7 @@ class AsyncImageProjectsClient:
 
         Examples:
         ```py
-        await client.v1.image_projects.get(id="string")
+        await client.v1.image_projects.get(id="cm6pvghix03bvyz0zwash6noj")
         ```
 
         """

{magic_hour-0.8.1 → magic_hour-0.8.3}/magic_hour/resources/v1/image_to_video/README.md

@@ -18,7 +18,7 @@ from os import getenv
 client = Client(token=getenv("API_TOKEN"))
 res = client.v1.image_to_video.create(
     assets={"image_file_path": "image/id/1234.png"},
-    end_seconds=5,
+    end_seconds=5.0,
     height=960,
     style={"prompt": None},
     width=512,
@@ -35,7 +35,7 @@ from os import getenv
 client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.image_to_video.create(
     assets={"image_file_path": "image/id/1234.png"},
-    end_seconds=5,
+    end_seconds=5.0,
     height=960,
     style={"prompt": None},
     width=512,

{magic_hour-0.8.1 → magic_hour-0.8.3}/magic_hour/resources/v1/image_to_video/client.py

@@ -58,7 +58,7 @@ class ImageToVideoClient:
         ```py
         client.v1.image_to_video.create(
             assets={"image_file_path": "image/id/1234.png"},
-            end_seconds=5,
+            end_seconds=5.0,
             height=960,
             style={"prompt": "string"},
             width=512,
@@ -135,7 +135,7 @@ class AsyncImageToVideoClient:
         ```py
         await client.v1.image_to_video.create(
             assets={"image_file_path": "image/id/1234.png"},
-            end_seconds=5,
+            end_seconds=5.0,
             height=960,
             style={"prompt": "string"},
             width=512,

{magic_hour-0.8.1 → magic_hour-0.8.3}/magic_hour/resources/v1/lip_sync/README.md

@@ -22,11 +22,11 @@ res = client.v1.lip_sync.create(
         "video_file_path": "video/id/1234.mp4",
         "video_source": "file",
     },
-    end_seconds=15,
+    end_seconds=15.0,
     height=960,
-    start_seconds=0,
+    start_seconds=0.0,
     width=512,
-    max_fps_limit=12,
+    max_fps_limit=12.0,
     name="Lip Sync video",
 )
 ```
@@ -44,11 +44,11 @@ res = await client.v1.lip_sync.create(
         "video_file_path": "video/id/1234.mp4",
         "video_source": "file",
     },
-    end_seconds=15,
+    end_seconds=15.0,
     height=960,
-    start_seconds=0,
+    start_seconds=0.0,
     width=512,
-    max_fps_limit=12,
+    max_fps_limit=12.0,
     name="Lip Sync video",
 )
 ```

{magic_hour-0.8.1 → magic_hour-0.8.3}/magic_hour/resources/v1/lip_sync/client.py

@@ -62,11 +62,11 @@ class LipSyncClient:
         ```py
         client.v1.lip_sync.create(
             assets={"audio_file_path": "audio/id/1234.mp3", "video_source": "file"},
-            end_seconds=15,
+            end_seconds=15.0,
             height=960,
-            start_seconds=0,
+            start_seconds=0.0,
             width=512,
-            max_fps_limit=12,
+            max_fps_limit=12.0,
             name="Lip Sync video",
         )
         ```
@@ -145,11 +145,11 @@ class AsyncLipSyncClient:
         ```py
         await client.v1.lip_sync.create(
             assets={"audio_file_path": "audio/id/1234.mp3", "video_source": "file"},
-            end_seconds=15,
+            end_seconds=15.0,
             height=960,
-            start_seconds=0,
+            start_seconds=0.0,
             width=512,
-            max_fps_limit=12,
+            max_fps_limit=12.0,
             name="Lip Sync video",
         )
         ```

{magic_hour-0.8.1 → magic_hour-0.8.3}/magic_hour/resources/v1/text_to_video/README.md

@@ -17,7 +17,7 @@ from os import getenv
 
 client = Client(token=getenv("API_TOKEN"))
 res = client.v1.text_to_video.create(
-    end_seconds=5,
+    end_seconds=5.0,
     orientation="landscape",
     style={"prompt": "string"},
     name="Text To Video video",
@@ -32,7 +32,7 @@ from os import getenv
 
 client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.text_to_video.create(
-    end_seconds=5,
+    end_seconds=5.0,
     orientation="landscape",
     style={"prompt": "string"},
     name="Text To Video video",