magic_hour 0.8.0__tar.gz → 0.8.2__tar.gz

{magic_hour-0.8.0 → magic_hour-0.8.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: magic_hour
-Version: 0.8.0
-Summary: 
+Version: 0.8.2
+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,123 +16,117 @@ 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)
 
-## 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).
-
-Then, add the `Authorization` header to the request.
+## Install
 
-| 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)
 
-* [create](magic_hour/resources/v1/ai_clothes_changer/README.md#create) - AI Clothes Changer
+- [create](magic_hour/resources/v1/ai_clothes_changer/README.md#create) - AI Clothes Changer
 
 ### [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
+- [create](magic_hour/resources/v1/ai_headshot_generator/README.md#create) - AI Headshots
 
 ### [v1.ai_image_generator](magic_hour/resources/v1/ai_image_generator/README.md)
 
-* [create](magic_hour/resources/v1/ai_image_generator/README.md#create) - AI Images
+- [create](magic_hour/resources/v1/ai_image_generator/README.md#create) - AI Images
 
 ### [v1.ai_image_upscaler](magic_hour/resources/v1/ai_image_upscaler/README.md)
 
-* [create](magic_hour/resources/v1/ai_image_upscaler/README.md#create) - AI Image Upscaler
+- [create](magic_hour/resources/v1/ai_image_upscaler/README.md#create) - AI Image Upscaler
 
 ### [v1.ai_photo_editor](magic_hour/resources/v1/ai_photo_editor/README.md)
 
-* [create](magic_hour/resources/v1/ai_photo_editor/README.md#create) - AI Photo Editor
+- [create](magic_hour/resources/v1/ai_photo_editor/README.md#create) - AI Photo Editor
 
 ### [v1.ai_qr_code_generator](magic_hour/resources/v1/ai_qr_code_generator/README.md)
 
-* [create](magic_hour/resources/v1/ai_qr_code_generator/README.md#create) - AI QR Code
+- [create](magic_hour/resources/v1/ai_qr_code_generator/README.md#create) - AI QR Code
 
 ### [v1.animation](magic_hour/resources/v1/animation/README.md)
 
-* [create](magic_hour/resources/v1/animation/README.md#create) - Animation
+- [create](magic_hour/resources/v1/animation/README.md#create) - Animation
 
 ### [v1.face_swap](magic_hour/resources/v1/face_swap/README.md)
 
-* [create](magic_hour/resources/v1/face_swap/README.md#create) - Face Swap video
+- [create](magic_hour/resources/v1/face_swap/README.md#create) - Face Swap video
 
 ### [v1.face_swap_photo](magic_hour/resources/v1/face_swap_photo/README.md)
 
-* [create](magic_hour/resources/v1/face_swap_photo/README.md#create) - Face Swap Photo
+- [create](magic_hour/resources/v1/face_swap_photo/README.md#create) - Face Swap Photo
 
 ### [v1.files.upload_urls](magic_hour/resources/v1/files/upload_urls/README.md)
 
-* [create](magic_hour/resources/v1/files/upload_urls/README.md#create) - Generate asset upload urls
+- [create](magic_hour/resources/v1/files/upload_urls/README.md#create) - Generate asset upload urls
 
 ### [v1.image_background_remover](magic_hour/resources/v1/image_background_remover/README.md)
 
-* [create](magic_hour/resources/v1/image_background_remover/README.md#create) - Image Background Remover
+- [create](magic_hour/resources/v1/image_background_remover/README.md#create) - Image Background Remover
 
 ### [v1.image_projects](magic_hour/resources/v1/image_projects/README.md)
 
-* [delete](magic_hour/resources/v1/image_projects/README.md#delete) - Delete image
-* [get](magic_hour/resources/v1/image_projects/README.md#get) - Get image details
+- [delete](magic_hour/resources/v1/image_projects/README.md#delete) - Delete image
+- [get](magic_hour/resources/v1/image_projects/README.md#get) - Get image details
 
 ### [v1.image_to_video](magic_hour/resources/v1/image_to_video/README.md)
 
-* [create](magic_hour/resources/v1/image_to_video/README.md#create) - Image-to-Video
+- [create](magic_hour/resources/v1/image_to_video/README.md#create) - Image-to-Video
 
 ### [v1.lip_sync](magic_hour/resources/v1/lip_sync/README.md)
 
-* [create](magic_hour/resources/v1/lip_sync/README.md#create) - Lip Sync
+- [create](magic_hour/resources/v1/lip_sync/README.md#create) - Lip Sync
 
 ### [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
+- [create](magic_hour/resources/v1/text_to_video/README.md#create) - Text-to-Video
 
 ### [v1.video_projects](magic_hour/resources/v1/video_projects/README.md)
 
-* [delete](magic_hour/resources/v1/video_projects/README.md#delete) - Delete video
-* [get](magic_hour/resources/v1/video_projects/README.md#get) - Get video details
+- [delete](magic_hour/resources/v1/video_projects/README.md#delete) - Delete video
+- [get](magic_hour/resources/v1/video_projects/README.md#get) - Get video details
 
 ### [v1.video_to_video](magic_hour/resources/v1/video_to_video/README.md)
 
-* [create](magic_hour/resources/v1/video_to_video/README.md#create) - Video-to-Video
+- [create](magic_hour/resources/v1/video_to_video/README.md#create) - Video-to-Video
 
 <!-- MODULE DOCS END -->
 

{magic_hour-0.8.0 → magic_hour-0.8.2}/README.md

@@ -1,119 +1,113 @@
+# Magic Hour Python SDK
 
-# Magic Hour API Python SDK
+![PyPI - Version](https://img.shields.io/pypi/v/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).
-
-Then, add the `Authorization` header to the request.
+## Install
 
-| 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)
 
-* [create](magic_hour/resources/v1/ai_clothes_changer/README.md#create) - AI Clothes Changer
+- [create](magic_hour/resources/v1/ai_clothes_changer/README.md#create) - AI Clothes Changer
 
 ### [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
+- [create](magic_hour/resources/v1/ai_headshot_generator/README.md#create) - AI Headshots
 
 ### [v1.ai_image_generator](magic_hour/resources/v1/ai_image_generator/README.md)
 
-* [create](magic_hour/resources/v1/ai_image_generator/README.md#create) - AI Images
+- [create](magic_hour/resources/v1/ai_image_generator/README.md#create) - AI Images
 
 ### [v1.ai_image_upscaler](magic_hour/resources/v1/ai_image_upscaler/README.md)
 
-* [create](magic_hour/resources/v1/ai_image_upscaler/README.md#create) - AI Image Upscaler
+- [create](magic_hour/resources/v1/ai_image_upscaler/README.md#create) - AI Image Upscaler
 
 ### [v1.ai_photo_editor](magic_hour/resources/v1/ai_photo_editor/README.md)
 
-* [create](magic_hour/resources/v1/ai_photo_editor/README.md#create) - AI Photo Editor
+- [create](magic_hour/resources/v1/ai_photo_editor/README.md#create) - AI Photo Editor
 
 ### [v1.ai_qr_code_generator](magic_hour/resources/v1/ai_qr_code_generator/README.md)
 
-* [create](magic_hour/resources/v1/ai_qr_code_generator/README.md#create) - AI QR Code
+- [create](magic_hour/resources/v1/ai_qr_code_generator/README.md#create) - AI QR Code
 
 ### [v1.animation](magic_hour/resources/v1/animation/README.md)
 
-* [create](magic_hour/resources/v1/animation/README.md#create) - Animation
+- [create](magic_hour/resources/v1/animation/README.md#create) - Animation
 
 ### [v1.face_swap](magic_hour/resources/v1/face_swap/README.md)
 
-* [create](magic_hour/resources/v1/face_swap/README.md#create) - Face Swap video
+- [create](magic_hour/resources/v1/face_swap/README.md#create) - Face Swap video
 
 ### [v1.face_swap_photo](magic_hour/resources/v1/face_swap_photo/README.md)
 
-* [create](magic_hour/resources/v1/face_swap_photo/README.md#create) - Face Swap Photo
+- [create](magic_hour/resources/v1/face_swap_photo/README.md#create) - Face Swap Photo
 
 ### [v1.files.upload_urls](magic_hour/resources/v1/files/upload_urls/README.md)
 
-* [create](magic_hour/resources/v1/files/upload_urls/README.md#create) - Generate asset upload urls
+- [create](magic_hour/resources/v1/files/upload_urls/README.md#create) - Generate asset upload urls
 
 ### [v1.image_background_remover](magic_hour/resources/v1/image_background_remover/README.md)
 
-* [create](magic_hour/resources/v1/image_background_remover/README.md#create) - Image Background Remover
+- [create](magic_hour/resources/v1/image_background_remover/README.md#create) - Image Background Remover
 
 ### [v1.image_projects](magic_hour/resources/v1/image_projects/README.md)
 
-* [delete](magic_hour/resources/v1/image_projects/README.md#delete) - Delete image
-* [get](magic_hour/resources/v1/image_projects/README.md#get) - Get image details
+- [delete](magic_hour/resources/v1/image_projects/README.md#delete) - Delete image
+- [get](magic_hour/resources/v1/image_projects/README.md#get) - Get image details
 
 ### [v1.image_to_video](magic_hour/resources/v1/image_to_video/README.md)
 
-* [create](magic_hour/resources/v1/image_to_video/README.md#create) - Image-to-Video
+- [create](magic_hour/resources/v1/image_to_video/README.md#create) - Image-to-Video
 
 ### [v1.lip_sync](magic_hour/resources/v1/lip_sync/README.md)
 
-* [create](magic_hour/resources/v1/lip_sync/README.md#create) - Lip Sync
+- [create](magic_hour/resources/v1/lip_sync/README.md#create) - Lip Sync
 
 ### [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
+- [create](magic_hour/resources/v1/text_to_video/README.md#create) - Text-to-Video
 
 ### [v1.video_projects](magic_hour/resources/v1/video_projects/README.md)
 
-* [delete](magic_hour/resources/v1/video_projects/README.md#delete) - Delete video
-* [get](magic_hour/resources/v1/video_projects/README.md#get) - Get video details
+- [delete](magic_hour/resources/v1/video_projects/README.md#delete) - Delete video
+- [get](magic_hour/resources/v1/video_projects/README.md#get) - Get video details
 
 ### [v1.video_to_video](magic_hour/resources/v1/video_to_video/README.md)
 
-* [create](magic_hour/resources/v1/video_to_video/README.md#create) - Video-to-Video
+- [create](magic_hour/resources/v1/video_to_video/README.md#create) - Video-to-Video
 
 <!-- MODULE DOCS END -->

{magic_hour-0.8.0 → magic_hour-0.8.2}/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.0"
+    MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.8.1"

{magic_hour-0.8.0 → magic_hour-0.8.2}/magic_hour/resources/v1/ai_image_upscaler/client.py

@@ -36,7 +36,7 @@ class AiImageUpscalerClient:
         Args:
             name: The name of image
             assets: Provide the assets for upscaling
-            scale_factor: float
+            scale_factor: How much to scale the image. Must be either 2 or 4
             style: PostV1AiImageUpscalerBodyStyle
             request_options: Additional options to customize the HTTP request
 
@@ -102,7 +102,7 @@ class AsyncAiImageUpscalerClient:
         Args:
             name: The name of image
             assets: Provide the assets for upscaling
-            scale_factor: float
+            scale_factor: How much to scale the image. Must be either 2 or 4
             style: PostV1AiImageUpscalerBodyStyle
             request_options: Additional options to customize the HTTP request
 

{magic_hour-0.8.0 → magic_hour-0.8.2}/magic_hour/types/params/post_v1_ai_image_upscaler_body.py

@@ -28,6 +28,9 @@ class PostV1AiImageUpscalerBody(typing_extensions.TypedDict):
     """
 
     scale_factor: typing_extensions.Required[float]
+    """
+    How much to scale the image. Must be either 2 or 4
+    """
 
     style: typing_extensions.Required[PostV1AiImageUpscalerBodyStyle]
 

{magic_hour-0.8.0 → magic_hour-0.8.2}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "magic_hour"
-version = "0.8.0"
-description = ""
+version = "0.8.2"
+description = "Python SDK for Magic Hour API"
 readme = "README.md"
 authors = []
 packages = [{ include = "magic_hour" }]