magic_hour 0.16.1__tar.gz → 0.18.0__tar.gz

{magic_hour-0.16.1 → magic_hour-0.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: magic_hour
-Version: 0.16.1
+Version: 0.18.0
 Summary: Python SDK for Magic Hour API
 Requires-Python: >=3.8,<4.0
 Classifier: Programming Language :: Python :: 3
@@ -128,6 +128,10 @@ client = AsyncClient(token="my api key")
 
 * [create](magic_hour/resources/v1/lip_sync/README.md#create) - Lip Sync
 
+### [v1.photo_colorizer](magic_hour/resources/v1/photo_colorizer/README.md)
+
+* [create](magic_hour/resources/v1/photo_colorizer/README.md#create) - Photo Colorizer
+
 ### [v1.text_to_video](magic_hour/resources/v1/text_to_video/README.md)
 
 * [create](magic_hour/resources/v1/text_to_video/README.md#create) - Text-to-Video

{magic_hour-0.16.1 → magic_hour-0.18.0}/README.md

@@ -110,6 +110,10 @@ client = AsyncClient(token="my api key")
 
 * [create](magic_hour/resources/v1/lip_sync/README.md#create) - Lip Sync
 
+### [v1.photo_colorizer](magic_hour/resources/v1/photo_colorizer/README.md)
+
+* [create](magic_hour/resources/v1/photo_colorizer/README.md#create) - Photo Colorizer
+
 ### [v1.text_to_video](magic_hour/resources/v1/text_to_video/README.md)
 
 * [create](magic_hour/resources/v1/text_to_video/README.md#create) - Text-to-Video

{magic_hour-0.16.1 → magic_hour-0.18.0}/magic_hour/environment.py

@@ -5,4 +5,4 @@ class Environment(enum.Enum):
     """Pre-defined base URLs for the API"""
 
     ENVIRONMENT = "https://api.magichour.ai"
-    MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.16.1"
+    MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.18.0"

{magic_hour-0.16.1 → magic_hour-0.18.0}/magic_hour/resources/v1/client.py

@@ -55,6 +55,10 @@ from magic_hour.resources.v1.image_to_video import (
     ImageToVideoClient,
 )
 from magic_hour.resources.v1.lip_sync import AsyncLipSyncClient, LipSyncClient
+from magic_hour.resources.v1.photo_colorizer import (
+    AsyncPhotoColorizerClient,
+    PhotoColorizerClient,
+)
 from magic_hour.resources.v1.text_to_video import (
     AsyncTextToVideoClient,
     TextToVideoClient,
@@ -96,6 +100,7 @@ class V1Client:
         )
         self.image_to_video = ImageToVideoClient(base_client=self._base_client)
         self.lip_sync = LipSyncClient(base_client=self._base_client)
+        self.photo_colorizer = PhotoColorizerClient(base_client=self._base_client)
         self.text_to_video = TextToVideoClient(base_client=self._base_client)
         self.video_to_video = VideoToVideoClient(base_client=self._base_client)
 
@@ -135,5 +140,6 @@ class AsyncV1Client:
         )
         self.image_to_video = AsyncImageToVideoClient(base_client=self._base_client)
         self.lip_sync = AsyncLipSyncClient(base_client=self._base_client)
+        self.photo_colorizer = AsyncPhotoColorizerClient(base_client=self._base_client)
         self.text_to_video = AsyncTextToVideoClient(base_client=self._base_client)
         self.video_to_video = AsyncVideoToVideoClient(base_client=self._base_client)

{magic_hour-0.16.1 → magic_hour-0.18.0}/magic_hour/resources/v1/image_to_video/client.py

@@ -20,12 +20,16 @@ class ImageToVideoClient:
         *,
         assets: params.V1ImageToVideoCreateBodyAssets,
         end_seconds: float,
-        height: int,
         style: params.V1ImageToVideoCreateBodyStyle,
-        width: int,
+        height: typing.Union[
+            typing.Optional[int], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
         name: typing.Union[
             typing.Optional[str], type_utils.NotGiven
         ] = type_utils.NOT_GIVEN,
+        width: typing.Union[
+            typing.Optional[int], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> models.V1ImageToVideoCreateResponse:
         """
@@ -39,12 +43,16 @@ class ImageToVideoClient:
         POST /v1/image-to-video
 
         Args:
+            height: This field does not affect the output video's resolution. The video's orientation will match that of the input image.
+
+        It is retained solely for backward compatibility and will be deprecated in the future.
             name: The name of video
+            width: This field does not affect the output video's resolution. The video's orientation will match that of the input image.
+
+        It is retained solely for backward compatibility and will be deprecated in the future.
             assets: Provide the assets for image-to-video.
             end_seconds: The total duration of the output video in seconds.
-            height: The height of the input video. This value will help determine the final orientation of the output video. The output video resolution may not match the input.
             style: Attributed used to dictate the style of the output
-            width: The width of the input video. This value will help determine the final orientation of the output video. The output video resolution may not match the input.
             request_options: Additional options to customize the HTTP request
 
         Returns:
@@ -59,21 +67,21 @@ class ImageToVideoClient:
         client.v1.image_to_video.create(
             assets={"image_file_path": "api-assets/id/1234.png"},
             end_seconds=5.0,
-            height=960,
             style={"prompt": "a dog running"},
-            width=512,
+            height=960,
             name="Image To Video video",
+            width=512,
         )
         ```
         """
         _json = to_encodable(
             item={
+                "height": height,
                 "name": name,
+                "width": width,
                 "assets": assets,
                 "end_seconds": end_seconds,
-                "height": height,
                 "style": style,
-                "width": width,
             },
             dump_with=params._SerializerV1ImageToVideoCreateBody,
         )
@@ -96,12 +104,16 @@ class AsyncImageToVideoClient:
         *,
         assets: params.V1ImageToVideoCreateBodyAssets,
         end_seconds: float,
-        height: int,
         style: params.V1ImageToVideoCreateBodyStyle,
-        width: int,
+        height: typing.Union[
+            typing.Optional[int], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
         name: typing.Union[
             typing.Optional[str], type_utils.NotGiven
         ] = type_utils.NOT_GIVEN,
+        width: typing.Union[
+            typing.Optional[int], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> models.V1ImageToVideoCreateResponse:
         """
@@ -115,12 +127,16 @@ class AsyncImageToVideoClient:
         POST /v1/image-to-video
 
         Args:
+            height: This field does not affect the output video's resolution. The video's orientation will match that of the input image.
+
+        It is retained solely for backward compatibility and will be deprecated in the future.
             name: The name of video
+            width: This field does not affect the output video's resolution. The video's orientation will match that of the input image.
+
+        It is retained solely for backward compatibility and will be deprecated in the future.
             assets: Provide the assets for image-to-video.
             end_seconds: The total duration of the output video in seconds.
-            height: The height of the input video. This value will help determine the final orientation of the output video. The output video resolution may not match the input.
             style: Attributed used to dictate the style of the output
-            width: The width of the input video. This value will help determine the final orientation of the output video. The output video resolution may not match the input.
             request_options: Additional options to customize the HTTP request
 
         Returns:
@@ -135,21 +151,21 @@ class AsyncImageToVideoClient:
         await client.v1.image_to_video.create(
             assets={"image_file_path": "api-assets/id/1234.png"},
             end_seconds=5.0,
-            height=960,
             style={"prompt": "a dog running"},
-            width=512,
+            height=960,
             name="Image To Video video",
+            width=512,
         )
         ```
         """
         _json = to_encodable(
             item={
+                "height": height,
                 "name": name,
+                "width": width,
                 "assets": assets,
                 "end_seconds": end_seconds,
-                "height": height,
                 "style": style,
-                "width": width,
             },
             dump_with=params._SerializerV1ImageToVideoCreateBody,
         )

magic_hour-0.18.0/magic_hour/resources/v1/photo_colorizer/README.md

@@ -0,0 +1,31 @@
+
+### create <a name="create"></a>
+Photo Colorizer
+
+Colorize image. Each image costs 5 frames.
+
+**API Endpoint**: `POST /v1/photo-colorizer`
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.photo_colorizer.create(
+    assets={"image_file_path": "api-assets/id/1234.png"}, name="Photo Colorizer image"
+)
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.photo_colorizer.create(
+    assets={"image_file_path": "api-assets/id/1234.png"}, name="Photo Colorizer image"
+)
+```

magic_hour-0.18.0/magic_hour/resources/v1/photo_colorizer/__init__.py

@@ -0,0 +1,4 @@
+from .client import AsyncPhotoColorizerClient, PhotoColorizerClient
+
+
+__all__ = ["AsyncPhotoColorizerClient", "PhotoColorizerClient"]

magic_hour-0.18.0/magic_hour/resources/v1/photo_colorizer/client.py

@@ -0,0 +1,119 @@
+import typing
+
+from magic_hour.core import (
+    AsyncBaseClient,
+    RequestOptions,
+    SyncBaseClient,
+    default_request_options,
+    to_encodable,
+    type_utils,
+)
+from magic_hour.types import models, params
+
+
+class PhotoColorizerClient:
+    def __init__(self, *, base_client: SyncBaseClient):
+        self._base_client = base_client
+
+    def create(
+        self,
+        *,
+        assets: params.V1PhotoColorizerCreateBodyAssets,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> models.V1PhotoColorizerCreateResponse:
+        """
+        Photo Colorizer
+
+        Colorize image. Each image costs 5 frames.
+
+        POST /v1/photo-colorizer
+
+        Args:
+            name: The name of image
+            assets: Provide the assets for photo colorization
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            Success
+
+        Raises:
+            ApiError: A custom exception class that provides additional context
+                for API errors, including the HTTP status code and response body.
+
+        Examples:
+        ```py
+        client.v1.photo_colorizer.create(
+            assets={"image_file_path": "api-assets/id/1234.png"},
+            name="Photo Colorizer image",
+        )
+        ```
+        """
+        _json = to_encodable(
+            item={"name": name, "assets": assets},
+            dump_with=params._SerializerV1PhotoColorizerCreateBody,
+        )
+        return self._base_client.request(
+            method="POST",
+            path="/v1/photo-colorizer",
+            auth_names=["bearerAuth"],
+            json=_json,
+            cast_to=models.V1PhotoColorizerCreateResponse,
+            request_options=request_options or default_request_options(),
+        )
+
+
+class AsyncPhotoColorizerClient:
+    def __init__(self, *, base_client: AsyncBaseClient):
+        self._base_client = base_client
+
+    async def create(
+        self,
+        *,
+        assets: params.V1PhotoColorizerCreateBodyAssets,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> models.V1PhotoColorizerCreateResponse:
+        """
+        Photo Colorizer
+
+        Colorize image. Each image costs 5 frames.
+
+        POST /v1/photo-colorizer
+
+        Args:
+            name: The name of image
+            assets: Provide the assets for photo colorization
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            Success
+
+        Raises:
+            ApiError: A custom exception class that provides additional context
+                for API errors, including the HTTP status code and response body.
+
+        Examples:
+        ```py
+        await client.v1.photo_colorizer.create(
+            assets={"image_file_path": "api-assets/id/1234.png"},
+            name="Photo Colorizer image",
+        )
+        ```
+        """
+        _json = to_encodable(
+            item={"name": name, "assets": assets},
+            dump_with=params._SerializerV1PhotoColorizerCreateBody,
+        )
+        return await self._base_client.request(
+            method="POST",
+            path="/v1/photo-colorizer",
+            auth_names=["bearerAuth"],
+            json=_json,
+            cast_to=models.V1PhotoColorizerCreateResponse,
+            request_options=request_options or default_request_options(),
+        )

{magic_hour-0.16.1 → magic_hour-0.18.0}/magic_hour/types/models/__init__.py

@@ -26,6 +26,7 @@ from .v1_image_projects_get_response_downloads_item import (
 from .v1_image_projects_get_response_error import V1ImageProjectsGetResponseError
 from .v1_image_to_video_create_response import V1ImageToVideoCreateResponse
 from .v1_lip_sync_create_response import V1LipSyncCreateResponse
+from .v1_photo_colorizer_create_response import V1PhotoColorizerCreateResponse
 from .v1_text_to_video_create_response import V1TextToVideoCreateResponse
 from .v1_video_projects_get_response import V1VideoProjectsGetResponse
 from .v1_video_projects_get_response_download import V1VideoProjectsGetResponseDownload
@@ -57,6 +58,7 @@ __all__ = [
     "V1ImageProjectsGetResponseError",
     "V1ImageToVideoCreateResponse",
     "V1LipSyncCreateResponse",
+    "V1PhotoColorizerCreateResponse",
     "V1TextToVideoCreateResponse",
     "V1VideoProjectsGetResponse",
     "V1VideoProjectsGetResponseDownload",

magic_hour-0.18.0/magic_hour/types/models/v1_photo_colorizer_create_response.py

@@ -0,0 +1,25 @@
+import pydantic
+
+
+class V1PhotoColorizerCreateResponse(pydantic.BaseModel):
+    """
+    Success
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    frame_cost: int = pydantic.Field(
+        alias="frame_cost",
+    )
+    """
+    The frame cost of the image generation
+    """
+    id: str = pydantic.Field(
+        alias="id",
+    )
+    """
+    Unique ID of the image. This value can be used in the [get image project API](https://docs.magichour.ai/api-reference/image-projects/get-image-details) to fetch additional details such as status
+    """

{magic_hour-0.16.1 → magic_hour-0.18.0}/magic_hour/types/params/__init__.py

@@ -147,6 +147,14 @@ from .v1_lip_sync_create_body_assets import (
     V1LipSyncCreateBodyAssets,
     _SerializerV1LipSyncCreateBodyAssets,
 )
+from .v1_photo_colorizer_create_body import (
+    V1PhotoColorizerCreateBody,
+    _SerializerV1PhotoColorizerCreateBody,
+)
+from .v1_photo_colorizer_create_body_assets import (
+    V1PhotoColorizerCreateBodyAssets,
+    _SerializerV1PhotoColorizerCreateBodyAssets,
+)
 from .v1_text_to_video_create_body import (
     V1TextToVideoCreateBody,
     _SerializerV1TextToVideoCreateBody,
@@ -208,6 +216,8 @@ __all__ = [
     "V1ImageToVideoCreateBodyStyle",
     "V1LipSyncCreateBody",
     "V1LipSyncCreateBodyAssets",
+    "V1PhotoColorizerCreateBody",
+    "V1PhotoColorizerCreateBodyAssets",
     "V1TextToVideoCreateBody",
     "V1TextToVideoCreateBodyStyle",
     "V1VideoToVideoCreateBody",
@@ -251,6 +261,8 @@ __all__ = [
     "_SerializerV1ImageToVideoCreateBodyStyle",
     "_SerializerV1LipSyncCreateBody",
     "_SerializerV1LipSyncCreateBodyAssets",
+    "_SerializerV1PhotoColorizerCreateBody",
+    "_SerializerV1PhotoColorizerCreateBodyAssets",
     "_SerializerV1TextToVideoCreateBody",
     "_SerializerV1TextToVideoCreateBodyStyle",
     "_SerializerV1VideoToVideoCreateBody",

{magic_hour-0.16.1 → magic_hour-0.18.0}/magic_hour/types/params/v1_image_to_video_create_body.py

@@ -27,9 +27,11 @@ class V1ImageToVideoCreateBody(typing_extensions.TypedDict):
     The total duration of the output video in seconds.
     """
 
-    height: typing_extensions.Required[int]
+    height: typing_extensions.NotRequired[int]
     """
-    The height of the input video. This value will help determine the final orientation of the output video. The output video resolution may not match the input.
+    This field does not affect the output video's resolution. The video's orientation will match that of the input image.
+    
+    It is retained solely for backward compatibility and will be deprecated in the future.
     """
 
     name: typing_extensions.NotRequired[str]
@@ -42,9 +44,11 @@ class V1ImageToVideoCreateBody(typing_extensions.TypedDict):
     Attributed used to dictate the style of the output
     """
 
-    width: typing_extensions.Required[int]
+    width: typing_extensions.NotRequired[int]
     """
-    The width of the input video. This value will help determine the final orientation of the output video. The output video resolution may not match the input.
+    This field does not affect the output video's resolution. The video's orientation will match that of the input image.
+    
+    It is retained solely for backward compatibility and will be deprecated in the future.
     """
 
 
@@ -64,13 +68,9 @@ class _SerializerV1ImageToVideoCreateBody(pydantic.BaseModel):
     end_seconds: float = pydantic.Field(
         alias="end_seconds",
     )
-    height: int = pydantic.Field(
-        alias="height",
-    )
+    height: typing.Optional[int] = pydantic.Field(alias="height", default=None)
     name: typing.Optional[str] = pydantic.Field(alias="name", default=None)
     style: _SerializerV1ImageToVideoCreateBodyStyle = pydantic.Field(
         alias="style",
     )
-    width: int = pydantic.Field(
-        alias="width",
-    )
+    width: typing.Optional[int] = pydantic.Field(alias="width", default=None)

magic_hour-0.18.0/magic_hour/types/params/v1_photo_colorizer_create_body.py

@@ -0,0 +1,40 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_photo_colorizer_create_body_assets import (
+    V1PhotoColorizerCreateBodyAssets,
+    _SerializerV1PhotoColorizerCreateBodyAssets,
+)
+
+
+class V1PhotoColorizerCreateBody(typing_extensions.TypedDict):
+    """
+    V1PhotoColorizerCreateBody
+    """
+
+    assets: typing_extensions.Required[V1PhotoColorizerCreateBodyAssets]
+    """
+    Provide the assets for photo colorization
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of image
+    """
+
+
+class _SerializerV1PhotoColorizerCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1PhotoColorizerCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    assets: _SerializerV1PhotoColorizerCreateBodyAssets = pydantic.Field(
+        alias="assets",
+    )
+    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)

magic_hour-0.18.0/magic_hour/types/params/v1_photo_colorizer_create_body_assets.py

@@ -0,0 +1,28 @@
+import pydantic
+import typing_extensions
+
+
+class V1PhotoColorizerCreateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for photo colorization
+    """
+
+    image_file_path: typing_extensions.Required[str]
+    """
+    The image used to generate the colorized image. This value can be either the `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls), or the url of the file.
+    """
+
+
+class _SerializerV1PhotoColorizerCreateBodyAssets(pydantic.BaseModel):
+    """
+    Serializer for V1PhotoColorizerCreateBodyAssets handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    image_file_path: str = pydantic.Field(
+        alias="image_file_path",
+    )

{magic_hour-0.16.1 → magic_hour-0.18.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "magic_hour"
-version = "0.16.1"
+version = "0.18.0"
 description = "Python SDK for Magic Hour API"
 readme = "README.md"
 authors = []

{magic_hour-0.16.1 → magic_hour-0.18.0}/magic_hour/resources/v1/image_to_video/README.md

@@ -19,10 +19,10 @@ client = Client(token=getenv("API_TOKEN"))
 res = client.v1.image_to_video.create(
     assets={"image_file_path": "api-assets/id/1234.png"},
     end_seconds=5.0,
-    height=960,
     style={"prompt": "a dog running"},
-    width=512,
+    height=960,
     name="Image To Video video",
+    width=512,
 )
 ```
 
@@ -36,9 +36,9 @@ client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.image_to_video.create(
     assets={"image_file_path": "api-assets/id/1234.png"},
     end_seconds=5.0,
-    height=960,
     style={"prompt": "a dog running"},
-    width=512,
+    height=960,
     name="Image To Video video",
+    width=512,
 )
 ```