murf 1.0.0__py3-none-any.whl

murf/text_to_speech/types/generate_speech_request_model_version.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GenerateSpeechRequestModelVersion = typing.Union[typing.Literal["GEN1", "GEN2"], typing.Any]

murf/types/__init__.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .api_voice import ApiVoice
+from .api_voice_gender import ApiVoiceGender
+from .auth_token_response import AuthTokenResponse
+from .generate_speech_response import GenerateSpeechResponse
+from .pronunciation_detail import PronunciationDetail
+from .pronunciation_detail_type import PronunciationDetailType
+from .style_details import StyleDetails
+from .word_duration import WordDuration
+
+__all__ = [
+    "ApiVoice",
+    "ApiVoiceGender",
+    "AuthTokenResponse",
+    "GenerateSpeechResponse",
+    "PronunciationDetail",
+    "PronunciationDetailType",
+    "StyleDetails",
+    "WordDuration",
+]

murf/types/api_voice.py

@@ -0,0 +1,49 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from .api_voice_gender import ApiVoiceGender
+from .style_details import StyleDetails
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ApiVoice(UniversalBaseModel):
+    accent: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This field has been deprecated. Please refer to 'supportedLocales.detail' instead.
+    """
+
+    available_styles: typing_extensions.Annotated[
+        typing.Optional[typing.List[str]], FieldMetadata(alias="availableStyles")
+    ] = pydantic.Field(default=None)
+    """
+    This field has been deprecated. Please refer to 'supportedLocales.availableStyles' instead.
+    """
+
+    description: typing.Optional[str] = None
+    display_language: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayLanguage")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This field has been deprecated. Please refer to 'supportedLocales.detail' instead.
+    """
+
+    display_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayName")] = None
+    gender: typing.Optional[ApiVoiceGender] = None
+    locale: typing.Optional[str] = None
+    supported_locales: typing_extensions.Annotated[
+        typing.Optional[typing.Dict[str, StyleDetails]], FieldMetadata(alias="supportedLocales")
+    ] = None
+    voice_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="voiceId")] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

murf/types/api_voice_gender.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ApiVoiceGender = typing.Union[typing.Literal["Male", "Female", "NonBinary"], typing.Any]

murf/types/auth_token_response.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+import typing
+from ..core.serialization import FieldMetadata
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class AuthTokenResponse(UniversalBaseModel):
+    expiry_in_epoch_millis: typing_extensions.Annotated[
+        typing.Optional[int], FieldMetadata(alias="expiryInEpochMillis")
+    ] = pydantic.Field(default=None)
+    """
+    The timestamp at which the generated token will expire - in Unix time.
+    """
+
+    token: typing.Optional[str] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

murf/types/generate_speech_response.py

@@ -0,0 +1,44 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+import typing
+from ..core.serialization import FieldMetadata
+import pydantic
+from .word_duration import WordDuration
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GenerateSpeechResponse(UniversalBaseModel):
+    audio_file: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="audioFile")] = None
+    audio_length_in_seconds: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="audioLengthInSeconds")
+    ] = None
+    consumed_character_count: typing_extensions.Annotated[
+        typing.Optional[int], FieldMetadata(alias="consumedCharacterCount")
+    ] = pydantic.Field(default=None)
+    """
+    Number of characters consumed so far in the current billing cycle.
+    """
+
+    encoded_audio: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="encodedAudio")] = None
+    remaining_character_count: typing_extensions.Annotated[
+        typing.Optional[int], FieldMetadata(alias="remainingCharacterCount")
+    ] = pydantic.Field(default=None)
+    """
+    Remaining number of characters available for synthesis in the current billing cycle.
+    """
+
+    warning: typing.Optional[str] = None
+    word_durations: typing_extensions.Annotated[
+        typing.Optional[typing.List[WordDuration]], FieldMetadata(alias="wordDurations")
+    ] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

murf/types/pronunciation_detail.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .pronunciation_detail_type import PronunciationDetailType
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class PronunciationDetail(UniversalBaseModel):
+    """
+    An object used to define custom pronunciations.
+
+     Example 1: {"live":{"type": "IPA", "pronunciation": "laɪv"}}.
+
+     Example 2: {"2022":{"type": "SAY_AS", "pronunciation": "twenty twenty two"}}
+    """
+
+    pronunciation: typing.Optional[str] = None
+    type: typing.Optional[PronunciationDetailType] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

murf/types/pronunciation_detail_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PronunciationDetailType = typing.Union[typing.Literal["IPA", "SAY_AS"], typing.Any]

murf/types/style_details.py

@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+import typing
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class StyleDetails(UniversalBaseModel):
+    available_styles: typing_extensions.Annotated[
+        typing.Optional[typing.List[str]], FieldMetadata(alias="availableStyles")
+    ] = None
+    detail: typing.Optional[str] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

murf/types/word_duration.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+import typing
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class WordDuration(UniversalBaseModel):
+    end_ms: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="endMs")] = None
+    pitch_scale_maximum: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="pitchScaleMaximum")
+    ] = None
+    pitch_scale_minimum: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="pitchScaleMinimum")
+    ] = None
+    source_word_index: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="sourceWordIndex")] = None
+    start_ms: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="startMs")] = None
+    word: typing.Optional[str] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

murf/version.py

@@ -0,0 +1,3 @@
+from importlib import metadata
+
+__version__ = metadata.version("murf")

murf-1.0.0.dist-info/METADATA

@@ -0,0 +1,169 @@
+Metadata-Version: 2.1
+Name: murf
+Version: 1.0.0
+Summary: 
+Requires-Python: >=3.8,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
+Requires-Dist: typing_extensions (>=4.0.0)
+Description-Content-Type: text/markdown
+
+# 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 Murf Python library provides convenient access to the Murf API from Python.
+
+## Installation
+
+```sh
+pip install murf
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from murf import Murf
+
+client = Murf(
+    api_key="YOUR_API_KEY",
+)
+client.text_to_speech.generate(
+    text="And off they went. Gently walking into the sunset, with not a single care in the world",
+    variation=5,
+    voice_id="en-US-julia",
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+import asyncio
+
+from murf import AsyncMurf
+
+client = AsyncMurf(
+    api_key="YOUR_API_KEY",
+)
+
+
+async def main() -> None:
+    await client.text_to_speech.generate(
+        text="And off they went. Gently walking into the sunset, with not a single care in the world",
+        variation=5,
+        voice_id="en-US-julia",
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from murf.core.api_error import ApiError
+
+try:
+    client.text_to_speech.generate(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.text_to_speech.generate(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from murf import Murf
+
+client = Murf(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.text_to_speech.generate(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+```python
+import httpx
+from murf import Murf
+
+client = Murf(
+    ...,
+    httpx_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+

murf-1.0.0.dist-info/RECORD

@@ -0,0 +1,43 @@
+murf/__init__.py,sha256=FelCH6IXvOIQMPhoZH297uTV_qNkFQTIm5rs9BAsJJA,1146
+murf/auth/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
+murf/auth/client.py,sha256=mXUOPNju_oGpemo5yb-psqdru7b409R-smTw9heBh54,6118
+murf/base_client.py,sha256=sKhRFLjh1g85yRlj2PMAfHnjI60WrZmMdO7CIusrjOY,5597
+murf/client.py,sha256=yTZ56rACaAx6xdMTToRh6dm2woBFwfk35YeYc8jpLb4,4023
+murf/core/__init__.py,sha256=SQ85PF84B9MuKnBwHNHWemSGuy-g_515gFYNFhvEE0I,1438
+murf/core/api_error.py,sha256=RE8LELok2QCjABadECTvtDp7qejA1VmINCh6TbqPwSE,426
+murf/core/client_wrapper.py,sha256=SR7jfBJL7E-6grEQkA87jFkUNP4DyXUaraslBjedJik,1995
+murf/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
+murf/core/file.py,sha256=d4NNbX8XvXP32z8KpK2Xovv33nFfruIrpz0QWxlgpZk,2663
+murf/core/http_client.py,sha256=siUQ6UV0ARZALlxubqWSSAAPC9B4VW8y6MGlHStfaeo,19552
+murf/core/jsonable_encoder.py,sha256=qaF1gtgH-kQZb4kJskETwcCsOPUof-NnYVdszHkb-dM,3656
+murf/core/pydantic_utilities.py,sha256=Pj_AIcjRR-xc28URvV4t2XssDPjLvpN6HAcsY3MVLRM,11973
+murf/core/query_encoder.py,sha256=ekulqNd0j8TgD7ox-Qbz7liqX8-KP9blvT9DsRCenYM,2144
+murf/core/remove_none_from_dict.py,sha256=EU9SGgYidWq7SexuJbNs4-PZ-5Bl3Vppd864mS6vQZw,342
+murf/core/request_options.py,sha256=h0QUNCFVdCW_7GclVySCAY2w4NhtXVBUCmHgmzaxpcg,1681
+murf/core/serialization.py,sha256=D9h_t-RQON3-CHWs1C4ESY9B-Yd5d-l5lnTLb_X896g,9601
+murf/environment.py,sha256=UJ2CmhHv79L09Ug4ygReh0SKr4sS0OUcAXja9u_lQ4U,149
+murf/errors/__init__.py,sha256=Y88-JEjEvw-fav3aqMuQEKFf54uKkKUYELJ0yQNQ710,552
+murf/errors/bad_request_error.py,sha256=_EbO8mWqN9kFZPvIap8qa1lL_EWkRcsZe1HKV9GDWJY,264
+murf/errors/forbidden_error.py,sha256=QO1kKlhClAPES6zsEK7g9pglWnxn3KWaOCAawWOg6Aw,263
+murf/errors/internal_server_error.py,sha256=8USCagXyJJ1MOm9snpcXIUt6eNXvrd_aq7Gfcu1vlOI,268
+murf/errors/payment_required_error.py,sha256=7xjVK_OFqWNU7L0BloP5ns1kavWIbC2XMfbBVgK6rr4,269
+murf/errors/service_unavailable_error.py,sha256=aiWJkLwL3ZF8DUhnHA7DncgPR-gAA9Omj86XByHSVlg,272
+murf/errors/unauthorized_error.py,sha256=1ewNCqSG1P-uogB5yCNwreq4Bf3VRor0woSOXS4NjPU,266
+murf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+murf/text_to_speech/__init__.py,sha256=Xv0-uZoCGDrfYszMbB2sh5nsApPBrcmek6SDgljYfxA,167
+murf/text_to_speech/client.py,sha256=OiOPwUpWJHUbHoT0WEKPTd_a9PGJhXT83W3zRXnpBGs,22731
+murf/text_to_speech/types/__init__.py,sha256=Hq1g0iZQ8sHQVU32Pt6lEetGXKEUUntytBmIq4bVK0A,199
+murf/text_to_speech/types/generate_speech_request_model_version.py,sha256=y0NvjvNgtPrNcywVnq11MjANl-hJ7m-S5M_Ik5NP7c8,173
+murf/types/__init__.py,sha256=ZiZ2GFpQiOSZZ8EKYfeJF7grIYcCo6EYnnkPeijkbsU,657
+murf/types/api_voice.py,sha256=q56eq_iz_NnSCDWzxRvsJKFOU2Tje8vCrXHg1AmKf4U,1920
+murf/types/api_voice_gender.py,sha256=d0HtLLsXDckaiNE3mb7wojzRi6YwqzFiEnqdNecfo-E,169
+murf/types/auth_token_response.py,sha256=kc04BEfbgsTMuEnxGhs1hI3-4gtrOTOaKpR16Mg9Cc8,916
+murf/types/generate_speech_response.py,sha256=Ogcal0BKGW0m6kEuZIf7_k_wnEpyHFHJED8HmIzuWsU,1762
+murf/types/pronunciation_detail.py,sha256=wm8asAQsYkL6O7QIhFl9tDEvo23r50-BUWamzdybHcg,937
+murf/types/pronunciation_detail_type.py,sha256=ihRcpMJJBEZGo59TFZefg_tfl_LeU0wlOXfMjkUNmh0,164
+murf/types/style_details.py,sha256=Gh2ev6dv5K0uZU1ZRViWfITpJ5r7LmQvwV3PcxF1RKE,799
+murf/types/word_duration.py,sha256=RY29DhDLNnqg42Xt0vF0nq-qoLjXzCz_eWHbL5qvTjE,1253
+murf/version.py,sha256=pVGisqquGqFs8v4SJPE2o540FaaDKHWfOikWf4-9KKk,71
+murf-1.0.0.dist-info/METADATA,sha256=uo8PjJ6rOV1z92o5jrMcS4Psyx8PPH-lwvAFy648d5Y,4673
+murf-1.0.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+murf-1.0.0.dist-info/RECORD,,

murf-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.6.1
+Root-Is-Purelib: true
+Tag: py3-none-any