Skip to content

Commit da7410c

Browse files
committed
Release 0.0.128
0 parents  commit da7410c

File tree

91 files changed

+5395
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+5395
-0
lines changed

.fernignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Specify files that shouldn't be modified by Fern

.github/workflows/ci.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: ci
2+
3+
on: [push]
4+
jobs:
5+
compile:
6+
runs-on: ubuntu-20.04
7+
steps:
8+
- name: Checkout repo
9+
uses: actions/checkout@v3
10+
- name: Set up python
11+
uses: actions/setup-python@v4
12+
with:
13+
python-version: 3.8
14+
- name: Bootstrap poetry
15+
run: |
16+
curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1
17+
- name: Install dependencies
18+
run: poetry install
19+
- name: Compile
20+
run: poetry run mypy .
21+
test:
22+
runs-on: ubuntu-20.04
23+
steps:
24+
- name: Checkout repo
25+
uses: actions/checkout@v3
26+
- name: Set up python
27+
uses: actions/setup-python@v4
28+
with:
29+
python-version: 3.8
30+
- name: Bootstrap poetry
31+
run: |
32+
curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1
33+
- name: Install dependencies
34+
run: poetry install
35+
36+
- name: Test
37+
run: poetry run pytest -rP .
38+
39+
publish:
40+
needs: [compile, test]
41+
if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
42+
runs-on: ubuntu-20.04
43+
steps:
44+
- name: Checkout repo
45+
uses: actions/checkout@v3
46+
- name: Set up python
47+
uses: actions/setup-python@v4
48+
with:
49+
python-version: 3.8
50+
- name: Bootstrap poetry
51+
run: |
52+
curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1
53+
- name: Install dependencies
54+
run: poetry install
55+
- name: Publish to pypi
56+
run: |
57+
poetry config repositories.remote https://upload.pypi.org/legacy/
58+
poetry --no-interaction -v publish --build --repository remote --username "$PYPI_USERNAME" --password "$PYPI_PASSWORD"
59+
env:
60+
PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
61+
PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
dist/
2+
.mypy_cache/
3+
__pycache__/
4+
poetry.toml
5+
.ruff_cache/

README.md

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
# Speechifyinc Python Library
2+
3+
[![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)
4+
[![pypi](https://img.shields.io/pypi/v/speechify-api)](https://pypi.python.org/pypi/speechify-api)
5+
6+
The Speechifyinc Python library provides convenient access to the Speechifyinc API from Python.
7+
8+
## Installation
9+
10+
```sh
11+
pip install speechify-api
12+
```
13+
14+
## Reference
15+
16+
A full reference for this library is available [here](./reference.md).
17+
18+
## Usage
19+
20+
Instantiate and use the client with the following:
21+
22+
```python
23+
from speechifyinc import Speechify
24+
25+
client = Speechify(
26+
token="YOUR_TOKEN",
27+
)
28+
client.tts.audio.speech(
29+
input="input",
30+
voice_id="voice_id",
31+
)
32+
```
33+
34+
## Async Client
35+
36+
The SDK also exports an `async` client so that you can make non-blocking calls to our API.
37+
38+
```python
39+
import asyncio
40+
41+
from speechifyinc import AsyncSpeechify
42+
43+
client = AsyncSpeechify(
44+
token="YOUR_TOKEN",
45+
)
46+
47+
48+
async def main() -> None:
49+
await client.tts.audio.speech(
50+
input="input",
51+
voice_id="voice_id",
52+
)
53+
54+
55+
asyncio.run(main())
56+
```
57+
58+
## Exception Handling
59+
60+
When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
61+
will be thrown.
62+
63+
```python
64+
from speechifyinc.core.api_error import ApiError
65+
66+
try:
67+
client.tts.audio.speech(...)
68+
except ApiError as e:
69+
print(e.status_code)
70+
print(e.body)
71+
```
72+
73+
## Advanced
74+
75+
### Retries
76+
77+
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
78+
as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
79+
retry limit (default: 2).
80+
81+
A request is deemed retryable when any of the following HTTP status codes is returned:
82+
83+
- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
84+
- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
85+
- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
86+
87+
Use the `max_retries` request option to configure this behavior.
88+
89+
```python
90+
client.tts.audio.speech(..., request_options={
91+
"max_retries": 1
92+
})
93+
```
94+
95+
### Timeouts
96+
97+
The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
98+
99+
```python
100+
101+
from speechifyinc import Speechify
102+
103+
client = Speechify(
104+
...,
105+
timeout=20.0,
106+
)
107+
108+
109+
# Override timeout for a specific method
110+
client.tts.audio.speech(..., request_options={
111+
"timeout_in_seconds": 1
112+
})
113+
```
114+
115+
### Custom Client
116+
117+
You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
118+
and transports.
119+
```python
120+
import httpx
121+
from speechifyinc import Speechify
122+
123+
client = Speechify(
124+
...,
125+
httpx_client=httpx.Client(
126+
proxies="http://my.test.proxy.example.com",
127+
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
128+
),
129+
)
130+
```
131+
132+
## Contributing
133+
134+
While we value open-source contributions to this SDK, this library is generated programmatically.
135+
Additions made directly to this library would have to be moved over to our generation code,
136+
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
137+
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
138+
an issue first to discuss with us!
139+
140+
On the other hand, contributions to the README are always very welcome!

0 commit comments

Comments
 (0)