Skip to content

Commit 58ae7fd

Browse files
Update README.md
1 parent 84c214b commit 58ae7fd

File tree

1 file changed

+63
-14
lines changed

1 file changed

+63
-14
lines changed

README.md

Lines changed: 63 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,46 @@
1-
# Murf Python Library
1+
# Murf Python SDK
2+
3+
![Murf AI Logo](https://murf.ai/public-assets/home/Murf_Logo.png)
24

35
[![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)
46
[![pypi](https://img.shields.io/pypi/v/murf)](https://pypi.python.org/pypi/murf)
57
[![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)
68

7-
The Murf Python library provides convenient access to the Murf API from Python.
9+
## Table of Contents
10+
11+
- [Overview](#overview)
12+
- [Installation](#installation)
13+
- [Getting Started](#getting-started)
14+
- [Features](#features)
15+
- [Asynchronous Usage](#async-client)
16+
- [Exception Handling](#exception-handling)
17+
- [Advanced Configuration](#advanced)
18+
- [Contributing](#contributing)
19+
- [License](#license)
20+
21+
---
22+
23+
## Overview
24+
25+
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.
26+
27+
---
828

929
## Installation
1030

11-
```sh
31+
Check out the [HTTP API documentation](https://murf.ai/api/docs/introduction/quickstart).
32+
33+
Install the SDK using pip:
34+
35+
```bash
1236
pip install murf
1337
```
1438

15-
## Reference
16-
17-
A full reference for this library is available [here](./reference.md).
39+
---
1840

19-
## Usage
41+
## Getting Started
2042

21-
Instantiate and use the client with the following:
43+
Here's a quick example to get you started with the Murf SDK:
2244

2345
```python
2446
from murf import Murf
@@ -34,6 +56,25 @@ client.text_to_speech.generate(
3456
)
3557
```
3658

59+
For more detailed information, refer to the [official documentation](https://murf.ai/api/docs/introduction/quickstart).
60+
61+
---
62+
63+
## Features
64+
65+
- **Text-to-Speech Conversion:** Transform text into natural-sounding speech.
66+
- **Multilingual Support:** Access voices in over 13 languages, including English, French, German, Spanish, Italian, Hindi, Portuguese, Dutch, Korean, Chinese (Mandarin), Bengali, Tamil, and Polish.
67+
68+
![Murf AI Languages](https://murf.ai/public-assets/home/Murf_Lang.png)
69+
70+
- **Multiple Voice Styles:** Choose from 20+ speaking styles to suit your application's needs.
71+
- **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.
72+
- **Multiple Audio Formats:** Generate audio in various formats (e.g., MP3, WAV) with configurable sample rates for optimal quality.
73+
- **Real-Time Processing:** Benefit from asynchronous API calls that support non-blocking, real-time audio generation and streaming scenarios.
74+
75+
76+
---
77+
3778
## Async Client
3879

3980
The SDK also exports an `async` client so that you can make non-blocking calls to our API.
@@ -60,6 +101,8 @@ async def main() -> None:
60101
asyncio.run(main())
61102
```
62103

104+
---
105+
63106
## Exception Handling
64107

65108
When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
@@ -75,6 +118,8 @@ except ApiError as e:
75118
print(e.body)
76119
```
77120

121+
---
122+
78123
## Advanced
79124

80125
### Retries
@@ -134,12 +179,16 @@ client = Murf(
134179
)
135180
```
136181

182+
---
183+
137184
## Contributing
138185

139-
While we value open-source contributions to this SDK, this library is generated programmatically.
140-
Additions made directly to this library would have to be moved over to our generation code,
141-
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
142-
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
143-
an issue first to discuss with us!
186+
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
187+
188+
---
189+
190+
## License
191+
192+
Murf Python SDK is released under the [MIT License](LICENSE).
144193

145-
On the other hand, contributions to the README are always very welcome!
194+
---

0 commit comments

Comments
 (0)