magic_hour 0.9.5__py3-none-any.whl → 0.44.0__py3-none-any.whl

magic_hour/resources/v1/photo_colorizer/client.py

@@ -0,0 +1,248 @@
+import typing
+
+from magic_hour.helpers.logger import get_sdk_logger
+from magic_hour.resources.v1.files.client import AsyncFilesClient, FilesClient
+from magic_hour.resources.v1.image_projects.client import (
+    AsyncImageProjectsClient,
+    ImageProjectsClient,
+)
+from magic_hour.types import models, params
+from make_api_request import (
+    AsyncBaseClient,
+    RequestOptions,
+    SyncBaseClient,
+    default_request_options,
+    to_encodable,
+    type_utils,
+)
+
+
+logger = get_sdk_logger(__name__)
+
+
+class PhotoColorizerClient:
+    def __init__(self, *, base_client: SyncBaseClient):
+        self._base_client = base_client
+
+    def generate(
+        self,
+        *,
+        assets: params.V1PhotoColorizerGenerateBodyAssets,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        wait_for_completion: bool = True,
+        download_outputs: bool = True,
+        download_directory: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ):
+        """
+        Generate colorized photo (alias for create with additional functionality).
+
+        Colorize image. Each image costs 5 credits.
+
+        Args:
+            name: The name of image. This value is mainly used for your own identification of the image.
+            assets: Provide the assets for photo colorization
+            wait_for_completion: Whether to wait for the image project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided, the outputs will be downloaded to the current working directory
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            V1ImageProjectsGetResponseWithDownloads: The response from the Photo Colorizer API with the downloaded paths if `download_outputs` is True.
+
+        Examples:
+        ```py
+        response = client.v1.photo_colorizer.generate(
+            assets={"image_file_path": "path/to/black_white_photo.jpg"},
+            name="Colorized Photo",
+            wait_for_completion=True,
+            download_outputs=True,
+            download_directory="outputs/",
+        )
+        ```
+        """
+
+        file_client = FilesClient(base_client=self._base_client)
+
+        image_file_path = assets["image_file_path"]
+        assets["image_file_path"] = file_client.upload_file(file=image_file_path)
+
+        create_response = self.create(
+            assets=assets, name=name, request_options=request_options
+        )
+        logger.info(f"Photo Colorizer response: {create_response}")
+
+        image_projects_client = ImageProjectsClient(base_client=self._base_client)
+        response = image_projects_client.check_result(
+            id=create_response.id,
+            wait_for_completion=wait_for_completion,
+            download_outputs=download_outputs,
+            download_directory=download_directory,
+        )
+
+        return response
+
+    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 credits.
+
+        POST /v1/photo-colorizer
+
+        Args:
+            name: The name of image. This value is mainly used for your own identification of the 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 generate(
+        self,
+        *,
+        assets: params.V1PhotoColorizerGenerateBodyAssets,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        wait_for_completion: bool = True,
+        download_outputs: bool = True,
+        download_directory: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ):
+        """
+        Generate colorized photo (alias for create with additional functionality).
+
+        Colorize image. Each image costs 5 credits.
+
+        Args:
+            name: The name of image. This value is mainly used for your own identification of the image.
+            assets: Provide the assets for photo colorization
+            wait_for_completion: Whether to wait for the image project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided, the outputs will be downloaded to the current working directory
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            V1ImageProjectsGetResponseWithDownloads: The response from the Photo Colorizer API with the downloaded paths if `download_outputs` is True.
+
+        Examples:
+        ```py
+        response = await client.v1.photo_colorizer.generate(
+            assets={"image_file_path": "path/to/black_white_photo.jpg"},
+            name="Colorized Photo",
+            wait_for_completion=True,
+            download_outputs=True,
+            download_directory="outputs/",
+        )
+        ```
+        """
+
+        file_client = AsyncFilesClient(base_client=self._base_client)
+
+        image_file_path = assets["image_file_path"]
+        assets["image_file_path"] = await file_client.upload_file(file=image_file_path)
+
+        create_response = await self.create(
+            assets=assets, name=name, request_options=request_options
+        )
+        logger.info(f"Photo Colorizer response: {create_response}")
+
+        image_projects_client = AsyncImageProjectsClient(base_client=self._base_client)
+        response = await image_projects_client.check_result(
+            id=create_response.id,
+            wait_for_completion=wait_for_completion,
+            download_outputs=download_outputs,
+            download_directory=download_directory,
+        )
+
+        return response
+
+    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 credits.
+
+        POST /v1/photo-colorizer
+
+        Args:
+            name: The name of image. This value is mainly used for your own identification of the 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/resources/v1/text_to_video/README.md

@@ -1,14 +1,89 @@
+# v1.text_to_video
 
-### create <a name="create"></a>
-Text-to-Video
+## Module Functions
+
+<!-- CUSTOM DOCS START -->
+
+### Text To Video Generate Workflow <a name="generate"></a>
+
+The workflow performs the following action
+
+1. upload local assets to Magic Hour storage. So you can pass in a local path instead of having to upload files yourself
+2. trigger a generation
+3. poll for a completion status. This is configurable
+4. if success, download the output to local directory
+
+> [!TIP]
+> This is the recommended way to use the SDK unless you have specific needs where it is necessary to split up the actions.
+
+#### Parameters
+
+In Additional to the parameters listed in the `.create` section below, `.generate` introduces 3 new parameters:
+
+- `wait_for_completion` (bool, default True): Whether to wait for the project to complete.
+- `download_outputs` (bool, default True): Whether to download the generated files
+- `download_directory` (str, optional): Directory to save downloaded files (defaults to current directory)
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.text_to_video.generate(
+    end_seconds=5.0,
+    orientation="landscape",
+    style={"prompt": "a dog running"},
+    name="Text To Video video",
+    resolution="720p",
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.text_to_video.generate(
+    end_seconds=5.0,
+    orientation="landscape",
+    style={"prompt": "a dog running"},
+    name="Text To Video video",
+    resolution="720p",
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+<!-- CUSTOM DOCS END -->
+
+### Text-to-Video <a name="create"></a>
 
 Create a Text To Video video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
-  
-Get more information about this mode at our [product page](/products/text-to-video).
-  
+
+Get more information about this mode at our [product page](https://magichour.ai/products/text-to-video).
 
 **API Endpoint**: `POST /v1/text-to-video`
 
+#### Parameters
+
+| Parameter         | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Example                       |
+| ----------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
+| `end_seconds`     |    ✓     | The total duration of the output video in seconds. The value must be greater than or equal to 5 seconds and less than or equal to 60 seconds. Note: For 480p resolution, the value must be either 5 or 10.                                                                                                                                                                                                                                                                                              | `5.0`                         |
+| `orientation`     |    ✓     | Determines the orientation of the output video                                                                                                                                                                                                                                                                                                                                                                                                                                                          | `"landscape"`                 |
+| `style`           |    ✓     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | `{"prompt": "a dog running"}` |
+| `└─ prompt`       |    ✓     | The prompt used for the video.                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | `"a dog running"`             |
+| `└─ quality_mode` |    ✗     | DEPRECATED: Please use `resolution` field instead. For backward compatibility: * `quick` maps to 720p resolution * `studio` maps to 1080p resolution This field will be removed in a future version. Use the `resolution` field to directly to specify the resolution.                                                                                                                                                                                                                                  | `"quick"`                     |
+| `name`            |    ✗     | The name of video. This value is mainly used for your own identification of the video.                                                                                                                                                                                                                                                                                                                                                                                                                  | `"Text To Video video"`       |
+| `resolution`      |    ✗     | Controls the output video resolution. Defaults to `720p` if not specified. 480p and 720p are available on Creator, Pro, or Business tiers. However, 1080p require Pro or Business tier. **Options:** - `480p` - Supports only 5 or 10 second videos. Output: 24fps. Cost: 120 credits per 5 seconds. - `720p` - Supports videos between 5-60 seconds. Output: 30fps. Cost: 300 credits per 5 seconds. - `1080p` - Supports videos between 5-60 seconds. Output: 30fps. Cost: 600 credits per 5 seconds. | `"720p"`                      |
+
 #### Synchronous Client
 
 ```python
@@ -19,8 +94,9 @@ client = Client(token=getenv("API_TOKEN"))
 res = client.v1.text_to_video.create(
     end_seconds=5.0,
     orientation="landscape",
-    style={"prompt": "string"},
+    style={"prompt": "a dog running"},
     name="Text To Video video",
+    resolution="720p",
 )
 ```
 
@@ -34,7 +110,20 @@ client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.text_to_video.create(
     end_seconds=5.0,
     orientation="landscape",
-    style={"prompt": "string"},
+    style={"prompt": "a dog running"},
     name="Text To Video video",
+    resolution="720p",
 )
 ```
+
+#### Response
+
+##### Type
+
+[V1TextToVideoCreateResponse](/magic_hour/types/models/v1_text_to_video_create_response.py)
+
+##### Example
+
+```python
+{"credits_charged": 450, "estimated_frame_cost": 450, "id": "cuid-example"}
+```