Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions .fern/metadata.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"cliVersion": "5.50.3",
"cliVersion": "5.64.0",
"generatorName": "fernapi/fern-python-sdk",
"generatorVersion": "5.14.20",
"generatorConfig": {
Expand All @@ -9,8 +9,9 @@
},
"pyproject_python_version": ">=3.9"
},
"originGitCommit": "13f26db544c7ebda83d5d229fb387a34c8410ee0",
"originGitCommit": "9f50f669dbb3d0db633a6d904db8a5077b94764f",
"originGitCommitIsDirty": true,
"invokedBy": "manual",
"sdkVersion": "1.2.4"
"invokedBy": "ci",
"ciProvider": "unknown",
"sdkVersion": "2.0.1"
}
32 changes: 28 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Speechifyinc Python Library
# Speechify 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%2Fspeechifyinc%2Fspeechify-api-sdk-python)
[![pypi](https://img.shields.io/pypi/v/speechify-api)](https://pypi.python.org/pypi/speechify-api)

The Speechifyinc Python library provides convenient access to the Speechifyinc APIs from Python.
The Speechify Python library provides convenient access to the Speechify APIs from Python.

## Table of Contents

Expand All @@ -14,6 +14,7 @@ The Speechifyinc Python library provides convenient access to the Speechifyinc A
- [Environments](#environments)
- [Async Client](#async-client)
- [Exception Handling](#exception-handling)
- [Pagination](#pagination)
- [Advanced](#advanced)
- [Access Raw Response Data](#access-raw-response-data)
- [Retries](#retries)
Expand Down Expand Up @@ -43,7 +44,7 @@ Instantiate and use the client with the following:
from speechify import Speechify

client = Speechify(
api_key="<token>",
token="<token>",
)

client.audio.speech(
Expand Down Expand Up @@ -77,7 +78,7 @@ import asyncio
from speechify import AsyncSpeechify

client = AsyncSpeechify(
api_key="<token>",
token="<token>",
)


Expand Down Expand Up @@ -108,6 +109,29 @@ except ApiError as e:
print(e.body)
```

## Pagination

Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object.

```python
from speechify import Speechify

client = Speechify(
token="<token>",
)

client.voices.list()
```

```python
# You can also iterate through pages and access the typed response per page
pager = client.voices.list(...)
for page in pager.iter_pages():
print(page.response) # access the typed response for each page
for item in page:
print(item)
```

## Advanced

### Access Raw Response Data
Expand Down
18 changes: 9 additions & 9 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ dynamic = ["version"]

[tool.poetry]
name = "speechify-api"
version = "2.0.0"
version = "2.0.1"
description = "Official Speechify API SDK"
readme = "README.md"
authors = [
Expand Down
Loading
Loading