magic_hour 0.36.0__tar.gz → 0.36.1__tar.gz

{magic_hour-0.36.0 → magic_hour-0.36.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: magic_hour
-Version: 0.36.0
+Version: 0.36.1
 Summary: Python SDK for Magic Hour API
 Requires-Python: >=3.8,<4.0
 Classifier: Programming Language :: Python :: 3
@@ -254,6 +254,7 @@ download_urls = result.downloads
 
 ### [v1.files](magic_hour/resources/v1/files/README.md)
 
+* [upload-file](magic_hour/resources/v1/files/README.md#upload-file) - Upload File
 
 ### [v1.files.upload_urls](magic_hour/resources/v1/files/upload_urls/README.md)
 
@@ -266,6 +267,7 @@ download_urls = result.downloads
 
 ### [v1.image_projects](magic_hour/resources/v1/image_projects/README.md)
 
+* [check-result](magic_hour/resources/v1/image_projects/README.md#check-result) - Check results
 * [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
 
@@ -291,6 +293,7 @@ download_urls = result.downloads
 
 ### [v1.video_projects](magic_hour/resources/v1/video_projects/README.md)
 
+* [check-result](magic_hour/resources/v1/video_projects/README.md#check-result) - Check results
 * [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
 

{magic_hour-0.36.0 → magic_hour-0.36.1}/README.md

@@ -236,6 +236,7 @@ download_urls = result.downloads
 
 ### [v1.files](magic_hour/resources/v1/files/README.md)
 
+* [upload-file](magic_hour/resources/v1/files/README.md#upload-file) - Upload File
 
 ### [v1.files.upload_urls](magic_hour/resources/v1/files/upload_urls/README.md)
 
@@ -248,6 +249,7 @@ download_urls = result.downloads
 
 ### [v1.image_projects](magic_hour/resources/v1/image_projects/README.md)
 
+* [check-result](magic_hour/resources/v1/image_projects/README.md#check-result) - Check results
 * [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
 
@@ -273,6 +275,7 @@ download_urls = result.downloads
 
 ### [v1.video_projects](magic_hour/resources/v1/video_projects/README.md)
 
+* [check-result](magic_hour/resources/v1/video_projects/README.md#check-result) - Check results
 * [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
 

magic_hour-0.36.1/magic_hour/resources/v1/files/README.md

@@ -0,0 +1,40 @@
+# v1_files
+
+<!-- CUSTOM DOCS START -->
+
+### Upload File <a name="upload-file"></a>
+
+Upload a local file to Magic Hour Storage. The returned value is used for subsequent API calls.
+
+#### Parameters
+
+| Parameter | Required | Description                                                         | Example            |
+| --------- | :------: | ------------------------------------------------------------------- | ------------------ |
+| `file`    |    ✓     | A local file path, path like object, file URL, or file like object. | `"/tmp/image.png"` |
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+file_path = client.v1.files.upload_file("/path/to/your/image.jpg")
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+file_path = await client.v1.files.upload_file("/path/to/your/image.jpg")
+```
+
+
+<!-- CUSTOM DOCS END -->
+
+## Submodules
+- [upload_urls](upload_urls/README.md) - upload_urls
+

{magic_hour-0.36.0 → magic_hour-0.36.1}/magic_hour/resources/v1/image_projects/README.md

@@ -4,6 +4,50 @@
 
 <!-- CUSTOM DOCS START -->
 
+### Check results <a name="check-result"></a>
+
+Poll the details API to check on the status of the rendering. Optionally can also download the output
+
+#### Parameters
+
+| Parameter             | Required | Description                                                                                          | Example          |
+| --------------------- | :------: | ---------------------------------------------------------------------------------------------------- | ---------------- |
+| `id`                  |    ✓     | Unique ID of the image project. This value is returned by all of the POST APIs that create an image. | `"cuid-example"` |
+| `wait_for_completion` |    ✗     | Whether to wait for the project to complete.                                                         | `True`           |
+| `download_outputs`    |    ✗     | Whether to download the generated files                                                              | `True`           |
+| `download_directory`  |    ✗     | Directory to save downloaded files (defaults to current directory)                                   | `"./outputs"`    |
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.image_projects.check_result(
+  id="cuid-example",
+  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.image_projects.check_result(
+  id="cuid-example",
+  wait_for_completion=True,
+  download_outputs=True,
+  download_directory="outputs",
+)
+```
+
 <!-- CUSTOM DOCS END -->
 
 ### Delete image <a name="delete"></a>

{magic_hour-0.36.0 → magic_hour-0.36.1}/magic_hour/resources/v1/video_projects/README.md

@@ -4,6 +4,50 @@
 
 <!-- CUSTOM DOCS START -->
 
+### Check results <a name="check-result"></a>
+
+Poll the details API to check on the status of the rendering. Optionally can also download the output
+
+#### Parameters
+
+| Parameter             | Required | Description                                                                                          | Example          |
+| --------------------- | :------: | ---------------------------------------------------------------------------------------------------- | ---------------- |
+| `id`                  |    ✓     | Unique ID of the video project. This value is returned by all of the POST APIs that create an video. | `"cuid-example"` |
+| `wait_for_completion` |    ✗     | Whether to wait for the project to complete.                                                         | `True`           |
+| `download_outputs`    |    ✗     | Whether to download the generated files                                                              | `True`           |
+| `download_directory`  |    ✗     | Directory to save downloaded files (defaults to current directory)                                   | `"./outputs"`    |
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.video_projects.check_result(
+  id="cuid-example",
+  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.video_projects.check_result(
+  id="cuid-example",
+  wait_for_completion=True,
+  download_outputs=True,
+  download_directory="outputs",
+)
+```
+
 <!-- CUSTOM DOCS END -->
 
 ### Delete video <a name="delete"></a>

{magic_hour-0.36.0 → magic_hour-0.36.1}/pyproject.toml

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

magic_hour-0.36.0/magic_hour/resources/v1/files/README.md

@@ -1,6 +0,0 @@
-# v1_files
-
-
-## Submodules
-- [upload_urls](upload_urls/README.md) - upload_urls
-