chore: update OpenAPI spec filetype (#2)

rickstaa · web-flow · commit 9716da1b488b · 2024-08-26T15:23:23.000+02:00
This commit ensures that the SDKs are generated using the new yaml
OpenAPI spec instead of the Json one. It also fixes a small issue with
the python configuration which caused parts of the docs to show
as UNSET.
diff --git a/.devcontainer/README.md b/.devcontainer/README.md
@@ -1,4 +1,9 @@
 
+<div align="center">
+    <a href="https://codespaces.new/livepeer/livepeer-ai-python.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
+</div>
+<br>
+
 > **Remember to shutdown a GitHub Codespace when it is not in use!**
 
 # Dev Containers Quick Start
@@ -20,11 +25,11 @@ The speakeasy CLI allows you to generate more usage snippets. Here's how:
 - To generate a sample for a specific operation by providing an operation ID, use:
 
 ```
-speakeasy generate usage -s https://raw.githubusercontent.com/livepeer/ai-worker/main/runner/gateway.openapi.json -l python -i {INPUT_OPERATION_ID} -o ./samples
+speakeasy generate usage -s https://raw.githubusercontent.com/livepeer/ai-worker/main/runner/gateway.openapi.yaml -l python -i {INPUT_OPERATION_ID} -o ./samples
 ```
 
 - To generate samples for an entire namespace (like a tag or group name), use:
 
 ```
-speakeasy generate usage -s https://raw.githubusercontent.com/livepeer/ai-worker/main/runner/gateway.openapi.json -l python -n {INPUT_TAG_NAME} -o ./samples
+speakeasy generate usage -s https://raw.githubusercontent.com/livepeer/ai-worker/main/runner/gateway.openapi.yaml -l python -n {INPUT_TAG_NAME} -o ./samples
 ```
diff --git a/.devcontainer/setup.sh b/.devcontainer/setup.sh
@@ -11,4 +11,4 @@ python -m pip install --upgrade pip
 pip install -e .
 
 # Generate starter usage sample with speakeasy
-speakeasy generate usage -s https://raw.githubusercontent.com/livepeer/ai-worker/main/runner/gateway.openapi.json -l python -o samples/root.py
+speakeasy generate usage -s https://raw.githubusercontent.com/livepeer/ai-worker/main/runner/gateway.openapi.yaml -l python -o samples/root.py
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: 2d5dbf5a-62be-411a-9c7b-bc7b6dc79e13
 management:
-  docChecksum: c222ffbf28e5f62770dc8cbd99010f96
+  docChecksum: cd6c43d2e31a6a23e22275e50c38d52e
   docVersion: v0.1.2
-  speakeasyVersion: 1.377.0
-  generationVersion: 2.404.0
-  releaseVersion: 0.1.4
-  configChecksum: a4b1b6e1d971710b6648986f1a937812
+  speakeasyVersion: 1.379.0
+  generationVersion: 2.404.3
+  releaseVersion: 0.1.5
+  configChecksum: 35690181912086c4003337e1ec0bd202
   repoURL: https://github.com/livepeer/livepeer-ai-python.git
   installationURL: https://github.com/livepeer/livepeer-ai-python.git
 features:
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -2,7 +2,7 @@ configVersion: 2.0.0
 generation:
   devContainers:
     enabled: true
-    schemaPath: https://raw.githubusercontent.com/livepeer/ai-worker/main/runner/gateway.openapi.json
+    schemaPath: https://raw.githubusercontent.com/livepeer/ai-worker/main/runner/gateway.openapi.yaml
   sdkClassName: LivepeerAI
   maintainOpenAPIOrder: true
   usageSnippets:
@@ -15,7 +15,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: false
 python:
-  version: 0.1.4
+  version: 0.1.5
   additionalDependencies:
     dev: {}
     main: {}
diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,12 +1,11 @@
-speakeasyVersion: 1.377.0
+speakeasyVersion: 1.379.0
 sources:
     livepeer_ai-OAS:
         sourceNamespace: livepeer-ai-oas
-        sourceRevisionDigest: sha256:eaa66566d7629ca0b84b572f39576e8b38b87667aaa688ea98cf87629f7647ea
-        sourceBlobDigest: sha256:88b77186fc98fe193435d3069ab2e85fe4d404e802e4e23761979e984649ff70
+        sourceRevisionDigest: sha256:6bd4223c4f6c0a9963663242f118035124c716e7c436049608219d24717cf099
+        sourceBlobDigest: sha256:a025967b0b9169763c785bb89478cb7716f70241d4e11d762734f3655b7fb0e5
         tags:
             - latest
-            - main
 targets:
     livepeer-ai:
         source: livepeer_ai-OAS
@@ -17,18 +16,18 @@ targets:
     livepeer-ai-python:
         source: livepeer_ai-OAS
         sourceNamespace: livepeer-ai-oas
-        sourceRevisionDigest: sha256:eaa66566d7629ca0b84b572f39576e8b38b87667aaa688ea98cf87629f7647ea
-        sourceBlobDigest: sha256:88b77186fc98fe193435d3069ab2e85fe4d404e802e4e23761979e984649ff70
+        sourceRevisionDigest: sha256:6bd4223c4f6c0a9963663242f118035124c716e7c436049608219d24717cf099
+        sourceBlobDigest: sha256:a025967b0b9169763c785bb89478cb7716f70241d4e11d762734f3655b7fb0e5
         codeSamplesNamespace: code-samples-python-livepeer-python
-        codeSamplesRevisionDigest: sha256:4b4d5d53563acb0a29f44c857bb3b87e8455831c298a17c1b3d02a7f235caca0
-        outLocation: /github/workspace/repo
+        codeSamplesRevisionDigest: sha256:901ab5f5b4d211b224c6482b451f186affa42c56cdf08c25f191f875146987d5
+        outLocation: /home/ricks/development/livepeer/ai/livepeer-ai-python
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
     sources:
         livepeer_ai-OAS:
             inputs:
-                - location: https://raw.githubusercontent.com/livepeer/ai-worker/main/runner/gateway.openapi.json
+                - location: https://raw.githubusercontent.com/livepeer/ai-worker/main/runner/gateway.openapi.yaml
             registry:
                 location: registry.speakeasyapi.dev/livepeer-8mq/livepeer-ai/livepeer-ai-oas
     targets:
diff --git a/.speakeasy/workflow.yaml b/.speakeasy/workflow.yaml
@@ -3,7 +3,7 @@ speakeasyVersion: latest
 sources:
     livepeer_ai-OAS:
         inputs:
-            - location: https://raw.githubusercontent.com/livepeer/ai-worker/main/runner/gateway.openapi.json
+            - location: https://raw.githubusercontent.com/livepeer/ai-worker/main/runner/gateway.openapi.yaml
         registry:
             location: registry.speakeasyapi.dev/livepeer-8mq/livepeer-ai/livepeer-ai-oas
 targets:
diff --git a/README.md b/README.md
@@ -14,12 +14,12 @@ Welcome to the [Livepeer AI](https://livepeer.ai/) Python! This library offers a
 
 PIP
 ```bash
-pip install git+<UNSET>.git
+pip install git+https://github.com/livepeer/livepeer-ai-python.git
 ```
 
 Poetry
 ```bash
-poetry add git+<UNSET>.git
+poetry add git+https://github.com/livepeer/livepeer-ai-python.git
 ```
 <!-- End SDK Installation [installation] -->
 
diff --git a/codeSamples.yaml b/codeSamples.yaml
@@ -3,6 +3,12 @@ info:
   title: CodeSamples overlay for python target
   version: 0.0.0
 actions:
+  - target: $["paths"]["/audio-to-text"]["post"]
+    update:
+      "x-codeSamples":
+        - "lang": "python"
+          "label": "audio_to_text"
+          "source": "from livepeer_ai import LivepeerAI\n\ns = LivepeerAI(\n    http_bearer=\"<YOUR_BEARER_TOKEN_HERE>\",\n)\n\n\nres = s.audio_to_text(request={\n    \"audio\": {\n        \"file_name\": \"your_file_here\",\n        \"content\": open(\"<file_path>\", \"rb\"),\n    },\n})\n\nif res.text_response is not None:\n    # handle response\n    pass"
   - target: $["paths"]["/text-to-image"]["post"]
     update:
       "x-codeSamples":
@@ -27,9 +33,3 @@ actions:
         - "lang": "python"
           "label": "upscale"
           "source": "from livepeer_ai import LivepeerAI\n\ns = LivepeerAI(\n    http_bearer=\"<YOUR_BEARER_TOKEN_HERE>\",\n)\n\n\nres = s.upscale(request={\n    \"prompt\": \"<value>\",\n    \"image\": {\n        \"file_name\": \"your_file_here\",\n        \"content\": open(\"<file_path>\", \"rb\"),\n    },\n})\n\nif res.image_response is not None:\n    # handle response\n    pass"
-  - target: $["paths"]["/audio-to-text"]["post"]
-    update:
-      "x-codeSamples":
-        - "lang": "python"
-          "label": "audio_to_text"
-          "source": "from livepeer_ai import LivepeerAI\n\ns = LivepeerAI(\n    http_bearer=\"<YOUR_BEARER_TOKEN_HERE>\",\n)\n\n\nres = s.audio_to_text(request={\n    \"audio\": {\n        \"file_name\": \"your_file_here\",\n        \"content\": open(\"<file_path>\", \"rb\"),\n    },\n})\n\nif res.text_response is not None:\n    # handle response\n    pass"
diff --git a/docs/models/apierror.md b/docs/models/apierror.md
@@ -1,8 +1,10 @@
 # APIError
 
+API error response model.
+
 
 ## Fields
 
 | Field              | Type               | Required           | Description        |
 | ------------------ | ------------------ | ------------------ | ------------------ |
-| `msg`              | *str*              | :heavy_check_mark: | N/A                |
+| `msg`              | *str*              | :heavy_check_mark: | The error message. |
diff --git a/docs/models/chunk.md b/docs/models/chunk.md
@@ -1,9 +1,11 @@
 # Chunk
 
+A chunk of text with a timestamp.
+
 
 ## Fields
 
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `timestamp`        | List[*Any*]        | :heavy_check_mark: | N/A                |
-| `text`             | *str*              | :heavy_check_mark: | N/A                |
+| Field                       | Type                        | Required                    | Description                 |
+| --------------------------- | --------------------------- | --------------------------- | --------------------------- |
+| `timestamp`                 | List[*Any*]                 | :heavy_check_mark:          | The timestamp of the chunk. |
+| `text`                      | *str*                       | :heavy_check_mark:          | The text of the chunk.      |
diff --git a/docs/models/httperror.md b/docs/models/httperror.md
@@ -1,10 +1,10 @@
 # HTTPError
 
-Bad Request
+HTTP error response model.
 
 
 ## Fields
 
 | Field                                    | Type                                     | Required                                 | Description                              |
 | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
-| `detail`                                 | [models.APIError](../models/apierror.md) | :heavy_check_mark:                       | N/A                                      |
+| `detail`                                 | [models.APIError](../models/apierror.md) | :heavy_check_mark:                       | Detailed error information.              |
diff --git a/docs/models/imageresponse.md b/docs/models/imageresponse.md
@@ -1,8 +1,10 @@
 # ImageResponse
 
+Response model for image generation.
+
 
 ## Fields
 
 | Field                                    | Type                                     | Required                                 | Description                              |
 | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
-| `images`                                 | List[[models.Media](../models/media.md)] | :heavy_check_mark:                       | N/A                                      |
+| `images`                                 | List[[models.Media](../models/media.md)] | :heavy_check_mark:                       | The generated images.                    |
diff --git a/docs/models/media.md b/docs/models/media.md
@@ -1,10 +1,12 @@
 # Media
 
+A media object containing information about the generated media.
+
 
 ## Fields
 
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `url`              | *str*              | :heavy_check_mark: | N/A                |
-| `seed`             | *int*              | :heavy_check_mark: | N/A                |
-| `nsfw`             | *bool*             | :heavy_check_mark: | N/A                |
+| Field                                    | Type                                     | Required                                 | Description                              |
+| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
+| `url`                                    | *str*                                    | :heavy_check_mark:                       | The URL where the media can be accessed. |
+| `seed`                                   | *int*                                    | :heavy_check_mark:                       | The seed used to generate the media.     |
+| `nsfw`                                   | *bool*                                   | :heavy_check_mark:                       | Whether the media was flagged as NSFW.   |
diff --git a/docs/models/textresponse.md b/docs/models/textresponse.md
@@ -1,9 +1,11 @@
 # TextResponse
 
+Response model for text generation.
+
 
 ## Fields
 
 | Field                                    | Type                                     | Required                                 | Description                              |
 | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
-| `text`                                   | *str*                                    | :heavy_check_mark:                       | N/A                                      |
-| `chunks`                                 | List[[models.Chunk](../models/chunk.md)] | :heavy_check_mark:                       | N/A                                      |
+| `text`                                   | *str*                                    | :heavy_check_mark:                       | The generated text.                      |
+| `chunks`                                 | List[[models.Chunk](../models/chunk.md)] | :heavy_check_mark:                       | The generated text chunks.               |
diff --git a/docs/models/videoresponse.md b/docs/models/videoresponse.md
@@ -1,8 +1,10 @@
 # VideoResponse
 
+Response model for image generation.
+
 
 ## Fields
 
 | Field                                    | Type                                     | Required                                 | Description                              |
 | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
-| `images`                                 | List[[models.Media](../models/media.md)] | :heavy_check_mark:                       | N/A                                      |
+| `images`                                 | List[[models.Media](../models/media.md)] | :heavy_check_mark:                       | The generated images.                    |
diff --git a/docs/sdks/livepeerai/README.md b/docs/sdks/livepeerai/README.md
@@ -14,7 +14,7 @@ Livepeer AI Runner: An application to run AI pipelines
 
 ## text_to_image
 
-Text To Image
+Generate images from text prompts.
 
 ### Example Usage
 
@@ -58,7 +58,7 @@ if res.image_response is not None:
 
 ## image_to_image
 
-Image To Image
+Apply image transformations to a provided image.
 
 ### Example Usage
 
@@ -106,7 +106,7 @@ if res.image_response is not None:
 
 ## image_to_video
 
-Image To Video
+Generate a video from a provided image.
 
 ### Example Usage
 
@@ -153,7 +153,7 @@ if res.video_response is not None:
 
 ## upscale
 
-Upscale
+Upscale an image by increasing its resolution.
 
 ### Example Usage
 
@@ -201,7 +201,7 @@ if res.image_response is not None:
 
 ## audio_to_text
 
-Audio To Text
+Transcribe audio files to text.
 
 ### Example Usage
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,9 +1,10 @@
 [tool.poetry]
 name = "livepeer-ai"
-version = "0.1.4"
+version = "0.1.5"
 description = "Python Client SDK for the Livepeer AI API."
 authors = ["Livepeer",]
 readme = "README-PYPI.md"
+repository = "https://github.com/livepeer/livepeer-ai-python.git"
 packages = [
     { include = "livepeer_ai", from = "src" }
 ]
diff --git a/scripts/prepare-readme.py b/scripts/prepare-readme.py
@@ -1,9 +1,33 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
+import re
 import shutil
 
 try:
-    shutil.copyfile('README.md', 'README-PYPI.md')
+    with open("README.md", "r") as rh:
+        readme_contents = rh.read()
+        GITHUB_URL = "https://github.com/livepeer/livepeer-ai-python.git"
+        GITHUB_URL = (
+            GITHUB_URL[: -len(".git")] if GITHUB_URL.endswith(".git") else GITHUB_URL
+        )
+        # links on PyPI should have absolute URLs
+        readme_contents = re.sub(
+            r"(\[[^\]]+\]\()((?!https?:)[^\)]+)(\))",
+            lambda m: m.group(1)
+            + GITHUB_URL
+            + "/blob/master/"
+            + m.group(2)
+            + m.group(3),
+            readme_contents,
+        )
+
+        with open("README-PYPI.md", "w") as wh:
+            wh.write(readme_contents)
 except Exception as e:
-    print("Failed to copy README.md to README-PYPI.md")
-    print(e)
+    try:
+        print("Failed to rewrite README.md to README-PYPI.md, copying original instead")
+        print(e)
+        shutil.copyfile("README.md", "README-PYPI.md")
+    except Exception as e:
+        print("Failed to copy README.md to README-PYPI.md")
+        print(e)
diff --git a/src/livepeer_ai/_hooks/__init__.py b/src/livepeer_ai/_hooks/__init__.py
@@ -2,3 +2,4 @@
 
 from .sdkhooks import *
 from .types import *
+from .registration import *
diff --git a/src/livepeer_ai/_hooks/registration.py b/src/livepeer_ai/_hooks/registration.py
@@ -0,0 +1,13 @@
+from .types import Hooks
+
+
+# This file is only ever generated once on the first generation and then is free to be modified.
+# Any hooks you wish to add should be registered in the init_hooks function. Feel free to define them
+# in this file or in separate files in the hooks folder.
+
+
+def init_hooks(hooks: Hooks):
+    # pylint: disable=unused-argument
+    """Add hooks by calling hooks.register{sdk_init/before_request/after_success/after_error}Hook 
+    with an instance of a hook that implements that specific Hook interface
+    Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance"""
diff --git a/src/livepeer_ai/_hooks/sdkhooks.py b/src/livepeer_ai/_hooks/sdkhooks.py
@@ -2,6 +2,7 @@
 
 import httpx
 from .types import SDKInitHook, BeforeRequestContext, BeforeRequestHook, AfterSuccessContext, AfterSuccessHook, AfterErrorContext, AfterErrorHook, Hooks
+from .registration import init_hooks
 from typing import List, Optional, Tuple
 from livepeer_ai.httpclient import HttpClient
 
@@ -11,6 +12,7 @@ def __init__(self) -> None:
         self.before_request_hooks: List[BeforeRequestHook] = []
         self.after_success_hooks: List[AfterSuccessHook] = []
         self.after_error_hooks: List[AfterErrorHook] = []
+        init_hooks(self)
 
     def register_sdk_init_hook(self, hook: SDKInitHook) -> None:
         self.sdk_init_hooks.append(hook)
diff --git a/src/livepeer_ai/models/apierror.py b/src/livepeer_ai/models/apierror.py
diff --git a/src/livepeer_ai/models/chunk.py b/src/livepeer_ai/models/chunk.py
diff --git a/src/livepeer_ai/models/httperror.py b/src/livepeer_ai/models/httperror.py
diff --git a/src/livepeer_ai/models/imageresponse.py b/src/livepeer_ai/models/imageresponse.py
diff --git a/src/livepeer_ai/models/media.py b/src/livepeer_ai/models/media.py
diff --git a/src/livepeer_ai/models/textresponse.py b/src/livepeer_ai/models/textresponse.py
diff --git a/src/livepeer_ai/models/videoresponse.py b/src/livepeer_ai/models/videoresponse.py
diff --git a/src/livepeer_ai/sdk.py b/src/livepeer_ai/sdk.py
diff --git a/src/livepeer_ai/sdkconfiguration.py b/src/livepeer_ai/sdkconfiguration.py
