Release 0.0.5

Author: fern-api[bot]

README.md

@@ -1,9 +1,9 @@
-# MurfAi Python Library
+# Murf Python Library
 
 [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fmurf-ai%2Fmurf-python-sdk)
 [![pypi](https://img.shields.io/pypi/v/murf)](https://pypi.python.org/pypi/murf)
 
-The MurfAi Python library provides convenient access to the MurfAi API from Python.
+The Murf Python library provides convenient access to the Murf API from Python.
 
 ## Installation
 
@@ -20,14 +20,17 @@ A full reference for this library is available [here](./reference.md).
 Instantiate and use the client with the following:
 
 ```python
-from murf_ai import Murf
+from murf import Murf
 
 client = Murf(
     api_key="YOUR_API_KEY",
 )
-client.speech_resource.generate_speech(
-    text="text",
-    voice_id="voiceId",
+client.text_to_speech.generate(
+    channel_type="STEREO",
+    format="MP3",
+    sample_rate=44100.0,
+    text="Hello, world!",
+    voice_id="en-US-natalie",
 )
 ```
 
@@ -38,17 +41,20 @@ The SDK also exports an `async` client so that you can make non-blocking calls t
 ```python
 import asyncio
 
-from murf_ai import AsyncMurf
+from murf import AsyncMurf
 
 client = AsyncMurf(
     api_key="YOUR_API_KEY",
 )
 
 
 async def main() -> None:
-    await client.speech_resource.generate_speech(
-        text="text",
-        voice_id="voiceId",
+    await client.text_to_speech.generate(
+        channel_type="STEREO",
+        format="MP3",
+        sample_rate=44100.0,
+        text="Hello, world!",
+        voice_id="en-US-natalie",
     )
 
 
@@ -61,10 +67,10 @@ When the API returns a non-success status code (4xx or 5xx response), a subclass
 will be thrown.
 
 ```python
-from murf_ai.core.api_error import ApiError
+from murf.core.api_error import ApiError
 
 try:
-    client.speech_resource.generate_speech(...)
+    client.text_to_speech.generate(...)
 except ApiError as e:
     print(e.status_code)
     print(e.body)
@@ -87,7 +93,7 @@ A request is deemed retriable when any of the following HTTP status codes is ret
 Use the `max_retries` request option to configure this behavior.
 
 ```python
-client.speech_resource.generate_speech(..., request_options={
+client.text_to_speech.generate(..., request_options={
     "max_retries": 1
 })
 ```
@@ -98,7 +104,7 @@ The SDK defaults to a 60 second timeout. You can configure this with a timeout o
 
 ```python
 
-from murf_ai import Murf
+from murf import Murf
 
 client = Murf(
     ...,
@@ -107,7 +113,7 @@ client = Murf(
 
 
 # Override timeout for a specific method
-client.speech_resource.generate_speech(..., request_options={
+client.text_to_speech.generate(..., request_options={
     "timeout_in_seconds": 1
 })
 ```
@@ -118,7 +124,7 @@ You can override the `httpx` client to customize it for your use-case. Some comm
 and transports.
 ```python
 import httpx
-from murf_ai import Murf
+from murf import Murf
 
 client = Murf(
     ...,

poetry.lock

@@ -3,7 +3,7 @@ name = "murf"
 
 [tool.poetry]
 name = "murf"
-version = "0.0.3"
+version = "0.0.5"
 description = ""
 readme = "README.md"
 authors = []
@@ -27,7 +27,7 @@ classifiers = [
     "Typing :: Typed"
 ]
 packages = [
-    { include = "murf_ai", from = "src"}
+    { include = "murf", from = "src"}
 ]
 
 [project.urls]

pyproject.toml

@@ -1,6 +1,6 @@
 # Reference
-## AuthenticationResource
-<details><summary><code>client.authentication_resource.<a href="src/murf_ai/authentication_resource/client.py">create_auth_token</a>()</code></summary>
+## Auth
+<details><summary><code>client.auth.<a href="src/murf/auth/client.py">generate_token</a>()</code></summary>
 <dl>
 <dd>
 
@@ -27,12 +27,12 @@ Generates an auth token for authenticating your requests
 <dd>
 
 ```python
-from murf_ai import Murf
+from murf import Murf
 
 client = Murf(
     api_key="YOUR_API_KEY",
 )
-client.authentication_resource.create_auth_token()
+client.auth.generate_token()
 
 ```
 </dd>
@@ -60,8 +60,8 @@ client.authentication_resource.create_auth_token()
 </dl>
 </details>
 
-## SpeechResource
-<details><summary><code>client.speech_resource.<a href="src/murf_ai/speech_resource/client.py">generate_speech</a>(...)</code></summary>
+## TextToSpeech
+<details><summary><code>client.text_to_speech.<a href="src/murf/text_to_speech/client.py">generate</a>(...)</code></summary>
 <dl>
 <dd>
 
@@ -88,14 +88,17 @@ Returns a url to the generated audio file along with other associated properties
 <dd>
 
 ```python
-from murf_ai import Murf
+from murf import Murf
 
 client = Murf(
     api_key="YOUR_API_KEY",
 )
-client.speech_resource.generate_speech(
-    text="text",
-    voice_id="voiceId",
+client.text_to_speech.generate(
+    channel_type="STEREO",
+    format="MP3",
+    sample_rate=44100.0,
+    text="Hello, world!",
+    voice_id="en-US-natalie",
 )
 
 ```
@@ -128,14 +131,6 @@ client.speech_resource.generate_speech(
 <dl>
 <dd>
 
-**token:** `typing.Optional[str]` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
 **audio_duration:** `typing.Optional[float]` — This parameter allows specifying the duration (in seconds) for the generated audio. If the value is 0, this parameter will be ignored. Only available for Gen2 model.
 
 </dd>
@@ -253,7 +248,7 @@ An object used to define custom pronunciations.
 </dl>
 </details>
 
-<details><summary><code>client.speech_resource.<a href="src/murf_ai/speech_resource/client.py">list_voices</a>(...)</code></summary>
+<details><summary><code>client.text_to_speech.<a href="src/murf/text_to_speech/client.py">get_voices</a>(...)</code></summary>
 <dl>
 <dd>
 
@@ -280,12 +275,12 @@ Returns a list of available voices for speech synthesis
 <dd>
 
 ```python
-from murf_ai import Murf
+from murf import Murf
 
 client = Murf(
     api_key="YOUR_API_KEY",
 )
-client.speech_resource.list_voices()
+client.text_to_speech.get_voices()
 
 ```
 </dd>

reference.md

@@ -18,10 +18,10 @@
     ServiceUnavailableError,
     UnauthorizedError,
 )
-from . import authentication_resource, speech_resource
+from . import auth, text_to_speech
 from .client import AsyncMurf, Murf
 from .environment import MurfEnvironment
-from .speech_resource import GenerateSpeechRequestModelVersion
+from .text_to_speech import GenerateSpeechRequestModelVersion
 from .version import __version__
 
 __all__ = [
@@ -44,6 +44,6 @@
     "UnauthorizedError",
     "WordDuration",
     "__version__",
-    "authentication_resource",
-    "speech_resource",
+    "auth",
+    "text_to_speech",
 ]

src/murf_ai/__init__.py src/murf/__init__.pysrc/murf_ai/__init__.py renamed to src/murf/__init__.py

@@ -13,11 +13,11 @@
 from ..core.client_wrapper import AsyncClientWrapper
 
 
-class AuthenticationResourceClient:
+class AuthClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    def create_auth_token(self, *, request_options: typing.Optional[RequestOptions] = None) -> AuthTokenResponse:
+    def generate_token(self, *, request_options: typing.Optional[RequestOptions] = None) -> AuthTokenResponse:
         """
         Generates an auth token for authenticating your requests
 
@@ -33,12 +33,12 @@ def create_auth_token(self, *, request_options: typing.Optional[RequestOptions]
 
         Examples
         --------
-        from murf_ai import Murf
+        from murf import Murf
 
         client = Murf(
             api_key="YOUR_API_KEY",
         )
-        client.authentication_resource.create_auth_token()
+        client.auth.generate_token()
         """
         _response = self._client_wrapper.httpx_client.request(
             "v1/auth/token",
@@ -90,11 +90,11 @@ def create_auth_token(self, *, request_options: typing.Optional[RequestOptions]
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
 
-class AsyncAuthenticationResourceClient:
+class AsyncAuthClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    async def create_auth_token(self, *, request_options: typing.Optional[RequestOptions] = None) -> AuthTokenResponse:
+    async def generate_token(self, *, request_options: typing.Optional[RequestOptions] = None) -> AuthTokenResponse:
         """
         Generates an auth token for authenticating your requests
 
@@ -112,15 +112,15 @@ async def create_auth_token(self, *, request_options: typing.Optional[RequestOpt
         --------
         import asyncio
 
-        from murf_ai import AsyncMurf
+        from murf import AsyncMurf
 
         client = AsyncMurf(
             api_key="YOUR_API_KEY",
         )
 
 
         async def main() -> None:
-            await client.authentication_resource.create_auth_token()
+            await client.auth.generate_token()
 
 
         asyncio.run(main())