magic_hour 0.18.0__tar.gz → 0.19.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: magic_hour
-Version: 0.18.0
+Version: 0.19.0
 Summary: Python SDK for Magic Hour API
 Requires-Python: >=3.8,<4.0
 Classifier: Programming Language :: Python :: 3
@@ -67,6 +67,10 @@ client = AsyncClient(token="my api key")
 
 * [create](magic_hour/resources/v1/ai_face_editor/README.md#create) - AI Face Editor
 
+### [v1.ai_gif_generator](magic_hour/resources/v1/ai_gif_generator/README.md)
+
+* [create](magic_hour/resources/v1/ai_gif_generator/README.md#create) - AI GIFs
+
 ### [v1.ai_headshot_generator](magic_hour/resources/v1/ai_headshot_generator/README.md)
 
 * [create](magic_hour/resources/v1/ai_headshot_generator/README.md#create) - AI Headshots

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

@@ -49,6 +49,10 @@ client = AsyncClient(token="my api key")
 
 * [create](magic_hour/resources/v1/ai_face_editor/README.md#create) - AI Face Editor
 
+### [v1.ai_gif_generator](magic_hour/resources/v1/ai_gif_generator/README.md)
+
+* [create](magic_hour/resources/v1/ai_gif_generator/README.md#create) - AI GIFs
+
 ### [v1.ai_headshot_generator](magic_hour/resources/v1/ai_headshot_generator/README.md)
 
 * [create](magic_hour/resources/v1/ai_headshot_generator/README.md#create) - AI Headshots

{magic_hour-0.18.0 → magic_hour-0.19.0}/magic_hour/core/__init__.py

@@ -18,6 +18,7 @@ from .request import (
     filter_not_given,
     to_content,
     to_encodable,
+    to_form_urlencoded,
     RequestOptions,
     default_request_options,
 )
@@ -42,6 +43,7 @@ __all__ = [
     "OAuth2ClientCredentialsForm",
     "OAuth2PasswordForm",
     "to_encodable",
+    "to_form_urlencoded",
     "filter_not_given",
     "to_content",
     "encode_query_param",

{magic_hour-0.18.0 → magic_hour-0.19.0}/magic_hour/core/query.py

@@ -1,3 +1,5 @@
+import json
+
 from typing import Any, Dict, Union
 from typing_extensions import Literal, Sequence
 from urllib.parse import quote_plus, quote
@@ -9,13 +11,14 @@ import httpx
 QueryParams = Dict[
     str, Union[httpx._types.PrimitiveData, Sequence[httpx._types.PrimitiveData]]
 ]
+QueryParamStyle = Literal["form", "spaceDelimited", "pipeDelimited", "deepObject"]
 
 
 def encode_query_param(
     params: QueryParams,
     name: str,
     value: Any,
-    style: Literal["form", "spaceDelimited", "pipeDelimited", "deepObject"] = "form",
+    style: QueryParamStyle = "form",
     explode: bool = True,
 ):
     if style == "form":
@@ -30,6 +33,13 @@ def encode_query_param(
         raise NotImplementedError(f"query param style '{style}' not implemented")
 
 
+def _query_str(val: Any) -> str:
+    """jsonify value without wrapping quotes for strings"""
+    if isinstance(val, str):
+        return val
+    return json.dumps(val)
+
+
 def _encode_form(params: QueryParams, name: str, value: Any, explode: bool):
     """
     Encodes query params in the `form` style as defined by OpenAPI with both explode and non-explode
@@ -37,18 +47,18 @@ def _encode_form(params: QueryParams, name: str, value: Any, explode: bool):
     """
     if isinstance(value, list) and not explode:
         # non-explode form lists should be encoded like /users?id=3,4,5
-        params[name] = quote_plus(",".join(map(str, value)))
+        params[name] = quote_plus(",".join(map(_query_str, value)))
     elif isinstance(value, dict):
         if explode:
             # explode form objects should be encoded like /users?key0=val0&key1=val1
             # the input param name will be omitted
             for k, v in value.items():
-                params[k] = quote_plus(str(v))
+                params[k] = quote_plus(_query_str(v))
         else:
             # non-explode form objects should be encoded like /users?id=key0,val0,key1,val1
             encoded_chunks = []
             for k, v in value.items():
-                encoded_chunks.extend([str(k), str(v)])
+                encoded_chunks.extend([str(k), _query_str(v)])
             params[name] = quote_plus(",".join(encoded_chunks))
     else:
         params[name] = value
@@ -61,7 +71,7 @@ def _encode_spaced_delimited(params: QueryParams, name: str, value: Any, explode
     """
     if isinstance(value, list) and not explode:
         # non-explode spaceDelimited lists should be encoded like /users?id=3%204%205
-        params[name] = quote(" ".join(map(str, value)))
+        params[name] = quote(" ".join(map(_query_str, value)))
     else:
         # according to the docs, spaceDelimited + explode=false only effects lists,
         # all other encodings are marked as n/a or are the same as `form` style
@@ -76,7 +86,7 @@ def _encode_pipe_delimited(params: QueryParams, name: str, value: Any, explode:
     """
     if isinstance(value, list) and not explode:
         # non-explode pipeDelimited lists should be encoded like /users?id=3|4|5
-        params[name] = quote("|".join(map(str, value)))
+        params[name] = quote("|".join(map(_query_str, value)))
     else:
         # according to the docs, pipeDelimited + explode=false only effects lists,
         # all other encodings are marked as n/a or are the same as `form` style
@@ -85,12 +95,15 @@ def _encode_pipe_delimited(params: QueryParams, name: str, value: Any, explode:
 
 
 def _encode_deep_object(params: QueryParams, name: str, value: Any, explode: bool):
-    """ """
-    if isinstance(value, dict):
+    """
+    Encodes query params in the `deepObject` style as defined by with both explode and non-explode
+    variants.
+    """
+    if isinstance(value, (dict, list)):
         _encode_deep_object_key(params, name, value)
     else:
         # according to the docs, deepObject style only applies to
-        # object encodes, encodings for primitives & arrays are listed as n/a,
+        # object encodes, encodings for primitives are listed as n/a,
         # fall back on form style as it is the default for query params
         _encode_form(params, name, value, explode)
 
@@ -103,4 +116,4 @@ def _encode_deep_object_key(params: QueryParams, key: str, value: Any):
         for i, v in enumerate(value):
             _encode_deep_object_key(params, f"{key}[{i}]", v)
     else:
-        params[key] = value
+        params[key] = _query_str(value)

{magic_hour-0.18.0 → magic_hour-0.19.0}/magic_hour/core/request.py

@@ -1,12 +1,11 @@
-from typing import Any, Dict, Type, Union, Sequence, List
-from urllib.parse import quote_plus
+from typing import Any, Dict, Type, Union, List, Mapping
 
 import httpx
 from typing_extensions import TypedDict, Required, NotRequired
 from pydantic import TypeAdapter, BaseModel
 
 from .type_utils import NotGiven
-from .query import QueryParams
+from .query import QueryParams, QueryParamStyle, encode_query_param
 
 """
 Request configuration and utility functions for handling HTTP requests.
@@ -96,6 +95,31 @@ def to_encodable(
     return model_dump(validated_item)
 
 
+def to_form_urlencoded(
+    *,
+    item: Any,
+    dump_with: Union[Type, Union[Type, Any]],
+    style: Mapping[str, QueryParamStyle],
+    explode: Mapping[str, bool],
+) -> Mapping[str, Any]:
+    """
+    Encodes object as x-www-form-urlencoded according to style and explode options
+    """
+    encoded = to_encodable(item=item, dump_with=dump_with)
+
+    if not isinstance(encoded, dict):
+        raise TypeError("x-www-form-urlencoded data must be an object at the top level")
+
+    form_data: QueryParams = {}
+
+    for key, val in encoded.items():
+        key_style = style.get(key, "form")
+        key_explode = explode.get(key, key_style == "form")
+        encode_query_param(form_data, key, val, style=key_style, explode=key_explode)
+
+    return form_data
+
+
 def to_content(*, file: httpx._types.FileTypes) -> httpx._types.RequestContent:
     """
     Converts the various ways files can be provided to something that is accepted by
@@ -112,24 +136,6 @@ def to_content(*, file: httpx._types.FileTypes) -> httpx._types.RequestContent:
         return file_content
 
 
-def encode_param(
-    value: Any, explode: bool
-) -> Union[httpx._types.PrimitiveData, Sequence[httpx._types.PrimitiveData]]:
-    """
-    Encodes parameter values for use in URLs.
-
-    Handles both simple values and collections, with special handling for
-    unexploded collections (combining them with commas) versus exploded ones.
-
-    Args:
-        explode: Whether to explode collections into separate parameters
-    """
-    if isinstance(value, (list, dict)) and not explode:
-        return quote_plus(",".join(map(str, value)))
-    else:
-        return value
-
-
 def filter_not_given(value: Any) -> Any:
     """Helper function to recursively filter out NotGiven values"""
     if isinstance(value, NotGiven):

{magic_hour-0.18.0 → magic_hour-0.19.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.18.0"
+    MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.19.0"

magic_hour-0.19.0/magic_hour/resources/v1/ai_gif_generator/README.md

@@ -0,0 +1,31 @@
+
+### create <a name="create"></a>
+AI GIFs
+
+Create an AI GIF. Each GIF costs 5 frames.
+
+**API Endpoint**: `POST /v1/ai-gif-generator`
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.ai_gif_generator.create(
+    style={"prompt": "Cute dancing cat, pixel art"}, name="Ai Gif gif"
+)
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.ai_gif_generator.create(
+    style={"prompt": "Cute dancing cat, pixel art"}, name="Ai Gif gif"
+)
+```

magic_hour-0.19.0/magic_hour/resources/v1/ai_gif_generator/__init__.py

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

magic_hour-0.19.0/magic_hour/resources/v1/ai_gif_generator/client.py

@@ -0,0 +1,117 @@
+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 AiGifGeneratorClient:
+    def __init__(self, *, base_client: SyncBaseClient):
+        self._base_client = base_client
+
+    def create(
+        self,
+        *,
+        style: params.V1AiGifGeneratorCreateBodyStyle,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> models.V1AiGifGeneratorCreateResponse:
+        """
+        AI GIFs
+
+        Create an AI GIF. Each GIF costs 5 frames.
+
+        POST /v1/ai-gif-generator
+
+        Args:
+            name: The name of gif
+            style: V1AiGifGeneratorCreateBodyStyle
+            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.ai_gif_generator.create(
+            style={"prompt": "Cute dancing cat, pixel art"}, name="Ai Gif gif"
+        )
+        ```
+        """
+        _json = to_encodable(
+            item={"name": name, "style": style},
+            dump_with=params._SerializerV1AiGifGeneratorCreateBody,
+        )
+        return self._base_client.request(
+            method="POST",
+            path="/v1/ai-gif-generator",
+            auth_names=["bearerAuth"],
+            json=_json,
+            cast_to=models.V1AiGifGeneratorCreateResponse,
+            request_options=request_options or default_request_options(),
+        )
+
+
+class AsyncAiGifGeneratorClient:
+    def __init__(self, *, base_client: AsyncBaseClient):
+        self._base_client = base_client
+
+    async def create(
+        self,
+        *,
+        style: params.V1AiGifGeneratorCreateBodyStyle,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> models.V1AiGifGeneratorCreateResponse:
+        """
+        AI GIFs
+
+        Create an AI GIF. Each GIF costs 5 frames.
+
+        POST /v1/ai-gif-generator
+
+        Args:
+            name: The name of gif
+            style: V1AiGifGeneratorCreateBodyStyle
+            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.ai_gif_generator.create(
+            style={"prompt": "Cute dancing cat, pixel art"}, name="Ai Gif gif"
+        )
+        ```
+        """
+        _json = to_encodable(
+            item={"name": name, "style": style},
+            dump_with=params._SerializerV1AiGifGeneratorCreateBody,
+        )
+        return await self._base_client.request(
+            method="POST",
+            path="/v1/ai-gif-generator",
+            auth_names=["bearerAuth"],
+            json=_json,
+            cast_to=models.V1AiGifGeneratorCreateResponse,
+            request_options=request_options or default_request_options(),
+        )

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

@@ -7,6 +7,10 @@ from magic_hour.resources.v1.ai_face_editor import (
     AiFaceEditorClient,
     AsyncAiFaceEditorClient,
 )
+from magic_hour.resources.v1.ai_gif_generator import (
+    AiGifGeneratorClient,
+    AsyncAiGifGeneratorClient,
+)
 from magic_hour.resources.v1.ai_headshot_generator import (
     AiHeadshotGeneratorClient,
     AsyncAiHeadshotGeneratorClient,
@@ -80,6 +84,7 @@ class V1Client:
         self.video_projects = VideoProjectsClient(base_client=self._base_client)
         self.ai_clothes_changer = AiClothesChangerClient(base_client=self._base_client)
         self.ai_face_editor = AiFaceEditorClient(base_client=self._base_client)
+        self.ai_gif_generator = AiGifGeneratorClient(base_client=self._base_client)
         self.ai_headshot_generator = AiHeadshotGeneratorClient(
             base_client=self._base_client
         )
@@ -114,6 +119,7 @@ class AsyncV1Client:
             base_client=self._base_client
         )
         self.ai_face_editor = AsyncAiFaceEditorClient(base_client=self._base_client)
+        self.ai_gif_generator = AsyncAiGifGeneratorClient(base_client=self._base_client)
         self.ai_headshot_generator = AsyncAiHeadshotGeneratorClient(
             base_client=self._base_client
         )

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

@@ -1,5 +1,6 @@
 from .v1_ai_clothes_changer_create_response import V1AiClothesChangerCreateResponse
 from .v1_ai_face_editor_create_response import V1AiFaceEditorCreateResponse
+from .v1_ai_gif_generator_create_response import V1AiGifGeneratorCreateResponse
 from .v1_ai_headshot_generator_create_response import (
     V1AiHeadshotGeneratorCreateResponse,
 )
@@ -40,6 +41,7 @@ from .v1_video_to_video_create_response import V1VideoToVideoCreateResponse
 __all__ = [
     "V1AiClothesChangerCreateResponse",
     "V1AiFaceEditorCreateResponse",
+    "V1AiGifGeneratorCreateResponse",
     "V1AiHeadshotGeneratorCreateResponse",
     "V1AiImageGeneratorCreateResponse",
     "V1AiImageUpscalerCreateResponse",

magic_hour-0.19.0/magic_hour/types/models/v1_ai_gif_generator_create_response.py

@@ -0,0 +1,25 @@
+import pydantic
+
+
+class V1AiGifGeneratorCreateResponse(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.18.0 → magic_hour-0.19.0}/magic_hour/types/models/v1_image_projects_get_response.py

@@ -72,5 +72,5 @@ class V1ImageProjectsGetResponse(pydantic.BaseModel):
         alias="type",
     )
     """
-    The type of the image project. Possible values are AI_HEADSHOT, AI_IMAGE, IMAGE_UPSCALER, FACE_SWAP, PHOTO_EDITOR, QR_CODE, BACKGROUND_REMOVER, CLOTHES_CHANGER, AI_MEME, FACE_EDITOR, PHOTO_COLORIZER
+    The type of the image project. Possible values are AI_HEADSHOT, AI_IMAGE, IMAGE_UPSCALER, FACE_SWAP, PHOTO_EDITOR, QR_CODE, BACKGROUND_REMOVER, CLOTHES_CHANGER, AI_MEME, FACE_EDITOR, PHOTO_COLORIZER, AI_GIF
     """

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

@@ -18,6 +18,14 @@ from .v1_ai_face_editor_create_body_style import (
     V1AiFaceEditorCreateBodyStyle,
     _SerializerV1AiFaceEditorCreateBodyStyle,
 )
+from .v1_ai_gif_generator_create_body import (
+    V1AiGifGeneratorCreateBody,
+    _SerializerV1AiGifGeneratorCreateBody,
+)
+from .v1_ai_gif_generator_create_body_style import (
+    V1AiGifGeneratorCreateBodyStyle,
+    _SerializerV1AiGifGeneratorCreateBodyStyle,
+)
 from .v1_ai_headshot_generator_create_body import (
     V1AiHeadshotGeneratorCreateBody,
     _SerializerV1AiHeadshotGeneratorCreateBody,
@@ -183,6 +191,8 @@ __all__ = [
     "V1AiFaceEditorCreateBody",
     "V1AiFaceEditorCreateBodyAssets",
     "V1AiFaceEditorCreateBodyStyle",
+    "V1AiGifGeneratorCreateBody",
+    "V1AiGifGeneratorCreateBodyStyle",
     "V1AiHeadshotGeneratorCreateBody",
     "V1AiHeadshotGeneratorCreateBodyAssets",
     "V1AiHeadshotGeneratorCreateBodyStyle",
@@ -228,6 +238,8 @@ __all__ = [
     "_SerializerV1AiFaceEditorCreateBody",
     "_SerializerV1AiFaceEditorCreateBodyAssets",
     "_SerializerV1AiFaceEditorCreateBodyStyle",
+    "_SerializerV1AiGifGeneratorCreateBody",
+    "_SerializerV1AiGifGeneratorCreateBodyStyle",
     "_SerializerV1AiHeadshotGeneratorCreateBody",
     "_SerializerV1AiHeadshotGeneratorCreateBodyAssets",
     "_SerializerV1AiHeadshotGeneratorCreateBodyStyle",

magic_hour-0.19.0/magic_hour/types/params/v1_ai_gif_generator_create_body.py

@@ -0,0 +1,37 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_ai_gif_generator_create_body_style import (
+    V1AiGifGeneratorCreateBodyStyle,
+    _SerializerV1AiGifGeneratorCreateBodyStyle,
+)
+
+
+class V1AiGifGeneratorCreateBody(typing_extensions.TypedDict):
+    """
+    V1AiGifGeneratorCreateBody
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of gif
+    """
+
+    style: typing_extensions.Required[V1AiGifGeneratorCreateBodyStyle]
+
+
+class _SerializerV1AiGifGeneratorCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1AiGifGeneratorCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)
+    style: _SerializerV1AiGifGeneratorCreateBodyStyle = pydantic.Field(
+        alias="style",
+    )

magic_hour-0.19.0/magic_hour/types/params/v1_ai_gif_generator_create_body_style.py

@@ -0,0 +1,28 @@
+import pydantic
+import typing_extensions
+
+
+class V1AiGifGeneratorCreateBodyStyle(typing_extensions.TypedDict):
+    """
+    V1AiGifGeneratorCreateBodyStyle
+    """
+
+    prompt: typing_extensions.Required[str]
+    """
+    The prompt used for the GIF.
+    """
+
+
+class _SerializerV1AiGifGeneratorCreateBodyStyle(pydantic.BaseModel):
+    """
+    Serializer for V1AiGifGeneratorCreateBodyStyle handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    prompt: str = pydantic.Field(
+        alias="prompt",
+    )

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

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