murf 1.0.1__py3-none-any.whl → 1.1.1__py3-none-any.whl

murf/dubbing_client.py

@@ -0,0 +1,120 @@
+from .base_client import BaseClient, AsyncBaseClient
+from .environment import MurfEnvironment
+import typing
+import os
+import httpx
+
+class MurfDub(BaseClient):
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : MurfEnvironment
+        The environment to use for requests from the client. from .environment import MurfEnvironment
+
+
+
+        Defaults to MurfEnvironment.DEFAULT
+
+
+
+    api_key : typing.Optional[str]
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.Client]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    Examples
+    --------
+    from murf import MurfDub
+
+    client = MurfDub(
+        api_key="YOUR_API_KEY",
+    )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: MurfEnvironment = MurfEnvironment.DEFAULT,
+        api_key: typing.Optional[str] = os.getenv("MURFDUB_API_KEY"),
+        timeout: typing.Optional[float] = 60,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.Client] = None,
+    ):
+        super().__init__(
+            base_url=base_url,
+            environment=environment,
+            api_key=api_key,
+            timeout=timeout,
+            follow_redirects=follow_redirects,
+            httpx_client=httpx_client
+        )
+        self.text_to_speech = None # type: ignore
+
+
+class AsyncMurfDub(AsyncBaseClient):
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : MurfEnvironment
+        The environment to use for requests from the client. from .environment import MurfEnvironment
+
+
+
+        Defaults to MurfEnvironment.DEFAULT
+
+
+
+    api_key : typing.Optional[str]
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.AsyncClient]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    Examples
+    --------
+    from murf import AsyncMurfDub
+
+    client = AsyncMurfDub(
+        api_key="YOUR_API_KEY",
+    )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: MurfEnvironment = MurfEnvironment.DEFAULT,
+        api_key: typing.Optional[str] = os.getenv("MURFDUB_API_KEY"),
+        timeout: typing.Optional[float] = 60,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.AsyncClient] = None,
+    ):
+        super().__init__(
+            base_url=base_url,
+            environment=environment,
+            api_key=api_key,
+            timeout=timeout,
+            follow_redirects=follow_redirects,
+            httpx_client=httpx_client
+        )
+        self.text_to_speech = None # type: ignore

murf/types/__init__.py

@@ -1,21 +1,45 @@
 # This file was auto-generated by Fern from our API Definition.
 
+from .api_job_response import ApiJobResponse
+from .api_job_response_dubbing_type import ApiJobResponseDubbingType
+from .api_job_response_priority import ApiJobResponsePriority
+from .api_project_response import ApiProjectResponse
+from .api_project_response_dubbing_type import ApiProjectResponseDubbingType
 from .api_voice import ApiVoice
 from .api_voice_gender import ApiVoiceGender
 from .auth_token_response import AuthTokenResponse
+from .dub_api_detail_response import DubApiDetailResponse
+from .dub_job_status_response import DubJobStatusResponse
+from .form_data_content_disposition import FormDataContentDisposition
 from .generate_speech_response import GenerateSpeechResponse
+from .group_api_project_response import GroupApiProjectResponse
+from .locale_response import LocaleResponse
+from .locale_response_supports_item import LocaleResponseSupportsItem
 from .pronunciation_detail import PronunciationDetail
 from .pronunciation_detail_type import PronunciationDetailType
+from .source_locale_response import SourceLocaleResponse
 from .style_details import StyleDetails
 from .word_duration import WordDuration
 
 __all__ = [
+    "ApiJobResponse",
+    "ApiJobResponseDubbingType",
+    "ApiJobResponsePriority",
+    "ApiProjectResponse",
+    "ApiProjectResponseDubbingType",
     "ApiVoice",
     "ApiVoiceGender",
     "AuthTokenResponse",
+    "DubApiDetailResponse",
+    "DubJobStatusResponse",
+    "FormDataContentDisposition",
     "GenerateSpeechResponse",
+    "GroupApiProjectResponse",
+    "LocaleResponse",
+    "LocaleResponseSupportsItem",
     "PronunciationDetail",
     "PronunciationDetailType",
+    "SourceLocaleResponse",
     "StyleDetails",
     "WordDuration",
 ]

murf/types/api_job_response.py

@@ -0,0 +1,53 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .api_job_response_dubbing_type import ApiJobResponseDubbingType
+import pydantic
+from .api_job_response_priority import ApiJobResponsePriority
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ApiJobResponse(UniversalBaseModel):
+    file_url: typing.Optional[str] = None
+    dubbing_type: ApiJobResponseDubbingType = pydantic.Field()
+    """
+    Dubbing Type
+    """
+
+    webhook_url: typing.Optional[str] = None
+    file_name: str = pydantic.Field()
+    """
+    Your Uploaded File Name
+    """
+
+    priority: ApiJobResponsePriority = pydantic.Field()
+    """
+    Priority of the job. Allowed values: LOW, NORMAL, HIGH
+    """
+
+    source_locale: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Source locale
+    """
+
+    job_id: str = pydantic.Field()
+    """
+    Your Job Id
+    """
+
+    target_locales: typing.List[str] = pydantic.Field()
+    """
+    List of target locales
+    """
+
+    warning: 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/api_job_response_dubbing_type.py

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

murf/types/api_job_response_priority.py

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

murf/types/api_project_response.py

@@ -0,0 +1,44 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import pydantic
+import typing
+from .api_project_response_dubbing_type import ApiProjectResponseDubbingType
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ApiProjectResponse(UniversalBaseModel):
+    project_id: str = pydantic.Field()
+    """
+    Your Project Id
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Project Name
+    """
+
+    description: typing.Optional[str] = None
+    source_locale: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Source Locale
+    """
+
+    dubbing_type: ApiProjectResponseDubbingType = pydantic.Field()
+    """
+    Dubbing Type
+    """
+
+    target_locales: typing.List[str] = pydantic.Field()
+    """
+    List of target locales
+    """
+
+    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_project_response_dubbing_type.py

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

murf/types/dub_api_detail_response.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class DubApiDetailResponse(UniversalBaseModel):
+    locale: typing.Optional[str] = None
+    status: typing.Optional[str] = None
+    error_message: typing.Optional[str] = None
+    download_url: typing.Optional[str] = None
+    download_srt_url: 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/dub_job_status_response.py

@@ -0,0 +1,39 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from .dub_api_detail_response import DubApiDetailResponse
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class DubJobStatusResponse(UniversalBaseModel):
+    project_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Your Project Id
+    """
+
+    job_id: str = pydantic.Field()
+    """
+    Your Job Id
+    """
+
+    status: str = pydantic.Field()
+    """
+    Your Job Status
+    """
+
+    download_details: typing.Optional[typing.List[DubApiDetailResponse]] = None
+    credits_used: typing.Optional[int] = None
+    credits_remaining: typing.Optional[int] = None
+    failure_reason: typing.Optional[str] = None
+    failure_code: 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/form_data_content_disposition.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import typing_extensions
+from ..core.serialization import FieldMetadata
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class FormDataContentDisposition(UniversalBaseModel):
+    type: typing.Optional[str] = None
+    parameters: typing.Optional[typing.Dict[str, str]] = None
+    file_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="fileName")] = None
+    creation_date: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="creationDate")] = None
+    modification_date: typing_extensions.Annotated[
+        typing.Optional[dt.datetime], FieldMetadata(alias="modificationDate")
+    ] = None
+    read_date: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="readDate")] = None
+    size: typing.Optional[int] = None
+    name: 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/group_api_project_response.py

@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .api_project_response import ApiProjectResponse
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GroupApiProjectResponse(UniversalBaseModel):
+    next: typing.Optional[str] = None
+    projects: typing.List[ApiProjectResponse] = pydantic.Field()
+    """
+    List of Projects
+    """
+
+    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/locale_response.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .locale_response_supports_item import LocaleResponseSupportsItem
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class LocaleResponse(UniversalBaseModel):
+    locale: str
+    language: str
+    supports: typing.List[LocaleResponseSupportsItem] = pydantic.Field()
+    """
+    Dubbing Type supported by locale
+    """
+
+    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/locale_response_supports_item.py

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

murf/types/source_locale_response.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class SourceLocaleResponse(UniversalBaseModel):
+    locale: str
+    language: str
+
+    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-1.0.1.dist-info → murf-1.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: murf
-Version: 1.0.1
+Version: 1.1.1
 Summary: 
 Requires-Python: >=3.8,<4.0
 Classifier: Intended Audience :: Developers
@@ -24,26 +24,49 @@ 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
+# Murf Python SDK
+
+![Murf AI Logo](https://murf.ai/public-assets/home/Murf_Logo.png)
 
 [![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)
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/gist/devgeetech-murf/bbe2c7eb01433f4a151f0fd2be23b1c8/murf-python-sdk.ipynb)
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Installation](#installation)
+- [Getting Started](#getting-started)
+- [Features](#features)
+- [Asynchronous Usage](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced Configuration](#advanced)
+- [Contributing](#contributing)
+- [License](#license)
+
+---
+
+## Overview
+
+The Murf Python SDK offers seamless integration with the [Murf AI](https://murf.ai/) [text-to-speech software](https://murf.ai/text-to-speech), enabling developers and creators to convert text into lifelike speech effortlessly. With over 130 natural-sounding voices across 13+ languages and 20+ speaking styles, Murf provides unparalleled speech customization for a wide range of applications. The SDK is designed for both synchronous and asynchronous workflows, featuring robust error handling, advanced configuration options, and support for real-time applications.
 
-The Murf Python library provides convenient access to the Murf API from Python.
+---
 
 ## Installation
 
-```sh
+Check out the [HTTP API documentation](https://murf.ai/api/docs/introduction/quickstart).
+
+Install the SDK using pip:
+
+```bash
 pip install murf
 ```
 
-## Reference
-
-A full reference for this library is available [here](./reference.md).
+---
 
-## Usage
+## Getting Started
 
-Instantiate and use the client with the following:
+Here's a quick example to get you started with the Murf SDK:
 
 ```python
 from murf import Murf
@@ -52,7 +75,6 @@ client = Murf(
     api_key="YOUR_API_KEY",
 )
 client.text_to_speech.generate(
-    channel_type="STEREO",
     format="MP3",
     sample_rate=44100.0,
     text="Hello, world!",
@@ -60,6 +82,25 @@ client.text_to_speech.generate(
 )
 ```
 
+For more detailed information, refer to the [official documentation](https://murf.ai/api/docs/introduction/quickstart).
+
+---
+
+## Features
+
+- **Text-to-Speech Conversion:** Transform text into natural-sounding speech.
+- **Multilingual Support:** Access voices in over 13 languages, including English, French, German, Spanish, Italian, Hindi, Portuguese, Dutch, Korean, Chinese (Mandarin), Bengali, Tamil, and Polish.
+
+![Murf AI Languages](https://murf.ai/public-assets/home/Murf_Lang.png)
+
+- **Multiple Voice Styles:** Choose from 20+ speaking styles to suit your application's needs.
+- **Advanced Voice Customization:** Adjust parameters like pitch, speed, pauses, and pronunciation for optimal output. Fine-grained controls let you tailor the voice output to match your specific requirements.
+- **Multiple Audio Formats:** Generate audio in various formats (e.g., MP3, WAV) with configurable sample rates for optimal quality.
+- **Real-Time Processing:** Benefit from asynchronous API calls that support non-blocking, real-time audio generation and streaming scenarios.
+
+
+---
+
 ## Async Client
 
 The SDK also exports an `async` client so that you can make non-blocking calls to our API.
@@ -76,7 +117,6 @@ client = AsyncMurf(
 
 async def main() -> None:
     await client.text_to_speech.generate(
-        channel_type="STEREO",
         format="MP3",
         sample_rate=44100.0,
         text="Hello, world!",
@@ -87,6 +127,8 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
+---
+
 ## Exception Handling
 
 When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
@@ -102,6 +144,8 @@ except ApiError as e:
     print(e.body)
 ```
 
+---
+
 ## Advanced
 
 ### Retries
@@ -161,13 +205,17 @@ client = Murf(
 )
 ```
 
+---
+
 ## 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!
+We welcome contributions to enhance the Murf Python SDK. Please note that this library is generated programmatically, so direct modifications may be overwritten. We suggest opening an issue first to discuss your ideas or improvements. Contributions to the documentation are especially appreciated! For any support queries email to support@murf.ai 
+
+---
+
+## License
+
+Murf Python SDK is released under the [MIT License](LICENSE).
 
-On the other hand, contributions to the README are always very welcome!
+---