speechify-api 1.2.2__tar.gz → 1.2.4__tar.gz

{speechify_api-1.2.2 → speechify_api-1.2.4}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: speechify-api
-Version: 1.2.2
+Version: 1.2.4
 Summary: Official Speechify API SDK
 Keywords: speechify,ai,api,sdk,text-to-speech,tts
 Author: Speechify
 Author-email: support@speechify.com
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.10,<4.0
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows
@@ -14,17 +14,24 @@ 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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
+Provides-Extra: aiohttp
+Requires-Dist: aiohttp (>=3.14.1,<4) ; (python_version >= "3.10") and (extra == "aiohttp")
 Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: httpx-aiohttp (==0.1.8) ; (python_version >= "3.10") and (extra == "aiohttp")
 Requires-Dist: pydantic (>=1.9.2)
 Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
 Requires-Dist: typing_extensions (>=4.0.0)
+Project-URL: Documentation, https://docs.speechify.ai/api-reference
+Project-URL: Homepage, https://docs.speechify.ai
+Project-URL: Repository, https://github.com/speechifyinc/speechify-api-sdk-python
 Description-Content-Type: text/markdown
 
 # Speechifyinc Python Library
@@ -34,9 +41,25 @@ Description-Content-Type: text/markdown
 
 The Speechifyinc Python library provides convenient access to the Speechifyinc APIs from Python.
 
+## Table of Contents
+
+- [Documentation](#documentation)
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Environments](#environments)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
 ## Documentation
 
-API reference documentation is available [here](https://docs.sws.speechify.com/api-reference).
+API reference documentation is available [here](https://docs.speechify.ai/api-reference).
 
 ## Installation
 
@@ -56,17 +79,33 @@ Instantiate and use the client with the following:
 from speechify import Speechify
 
 client = Speechify(
-    token="YOUR_TOKEN",
+    api_key="<token>",
+)
+
+client.audio.speech(
+    audio_format="mp3",
+    input="Hello! This is the Speechify text-to-speech API.",
+    model="simba-english",
+    voice_id="george",
 )
-client.tts.audio.speech(
-    input="input",
-    voice_id="voice_id",
+```
+
+## Environments
+
+This SDK allows you to configure different environments for API requests.
+
+```python
+from speechify import Speechify
+from speechify.environment import SpeechifyEnvironment
+
+client = Speechify(
+    environment=SpeechifyEnvironment.DEFAULT,
 )
 ```
 
 ## Async Client
 
-The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
 
 ```python
 import asyncio
@@ -74,14 +113,16 @@ import asyncio
 from speechify import AsyncSpeechify
 
 client = AsyncSpeechify(
-    token="YOUR_TOKEN",
+    api_key="<token>",
 )
 
 
 async def main() -> None:
-    await client.tts.audio.speech(
-        input="input",
-        voice_id="voice_id",
+    await client.audio.speech(
+        audio_format="mp3",
+        input="Hello! This is the Speechify text-to-speech API.",
+        model="simba-english",
+        voice_id="george",
     )
 
 
@@ -97,7 +138,7 @@ will be thrown.
 from speechify.core.api_error import ApiError
 
 try:
-    client.tts.audio.speech(...)
+    client.audio.speech(...)
 except ApiError as e:
     print(e.status_code)
     print(e.body)
@@ -105,22 +146,47 @@ except ApiError as e:
 
 ## Advanced
 
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from speechify import Speechify
+
+client = Speechify(...)
+response = client.audio.with_raw_response.speech(...)
+print(response.headers)  # access the response headers
+print(response.status_code)  # access the response status code
+print(response.data)  # access the underlying object
+```
+
 ### Retries
 
 The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
 as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
 retry limit (default: 2).
 
-A request is deemed retryable when any of the following HTTP status codes is returned:
+Which status codes are retried depends on the `retryStatusCodes` generator configuration:
+
+**`legacy`** (current default): retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [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#server_error_responses) (All server errors, including 500)
 
+**`recommended`**: retries on
 - [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
 - [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)
+- [502](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) (Bad Gateway)
+- [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) (Service Unavailable)
+- [504](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) (Gateway Timeout)
 
 Use the `max_retries` request option to configure this behavior.
 
 ```python
-client.tts.audio.speech(..., request_options={
+client.audio.speech(..., request_options={
     "max_retries": 1
 })
 ```
@@ -130,17 +196,12 @@ client.tts.audio.speech(..., request_options={
 The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
 
 ```python
-
 from speechify import Speechify
 
-client = Speechify(
-    ...,
-    timeout=20.0,
-)
-
+client = Speechify(..., timeout=20.0)
 
 # Override timeout for a specific method
-client.tts.audio.speech(..., request_options={
+client.audio.speech(..., request_options={
     "timeout_in_seconds": 1
 })
 ```
@@ -149,6 +210,7 @@ client.tts.audio.speech(..., request_options={
 
 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 speechify import Speechify
@@ -156,7 +218,7 @@ from speechify import Speechify
 client = Speechify(
     ...,
     httpx_client=httpx.Client(
-        proxies="http://my.test.proxy.example.com",
+        proxy="http://my.test.proxy.example.com",
         transport=httpx.HTTPTransport(local_address="0.0.0.0"),
     ),
 )

{speechify_api-1.2.2 → speechify_api-1.2.4}/README.md

@@ -5,9 +5,25 @@
 
 The Speechifyinc Python library provides convenient access to the Speechifyinc APIs from Python.
 
+## Table of Contents
+
+- [Documentation](#documentation)
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Environments](#environments)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
 ## Documentation
 
-API reference documentation is available [here](https://docs.sws.speechify.com/api-reference).
+API reference documentation is available [here](https://docs.speechify.ai/api-reference).
 
 ## Installation
 
@@ -27,17 +43,33 @@ Instantiate and use the client with the following:
 from speechify import Speechify
 
 client = Speechify(
-    token="YOUR_TOKEN",
+    api_key="<token>",
+)
+
+client.audio.speech(
+    audio_format="mp3",
+    input="Hello! This is the Speechify text-to-speech API.",
+    model="simba-english",
+    voice_id="george",
 )
-client.tts.audio.speech(
-    input="input",
-    voice_id="voice_id",
+```
+
+## Environments
+
+This SDK allows you to configure different environments for API requests.
+
+```python
+from speechify import Speechify
+from speechify.environment import SpeechifyEnvironment
+
+client = Speechify(
+    environment=SpeechifyEnvironment.DEFAULT,
 )
 ```
 
 ## Async Client
 
-The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
 
 ```python
 import asyncio
@@ -45,14 +77,16 @@ import asyncio
 from speechify import AsyncSpeechify
 
 client = AsyncSpeechify(
-    token="YOUR_TOKEN",
+    api_key="<token>",
 )
 
 
 async def main() -> None:
-    await client.tts.audio.speech(
-        input="input",
-        voice_id="voice_id",
+    await client.audio.speech(
+        audio_format="mp3",
+        input="Hello! This is the Speechify text-to-speech API.",
+        model="simba-english",
+        voice_id="george",
     )
 
 
@@ -68,7 +102,7 @@ will be thrown.
 from speechify.core.api_error import ApiError
 
 try:
-    client.tts.audio.speech(...)
+    client.audio.speech(...)
 except ApiError as e:
     print(e.status_code)
     print(e.body)
@@ -76,22 +110,47 @@ except ApiError as e:
 
 ## Advanced
 
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from speechify import Speechify
+
+client = Speechify(...)
+response = client.audio.with_raw_response.speech(...)
+print(response.headers)  # access the response headers
+print(response.status_code)  # access the response status code
+print(response.data)  # access the underlying object
+```
+
 ### Retries
 
 The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
 as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
 retry limit (default: 2).
 
-A request is deemed retryable when any of the following HTTP status codes is returned:
+Which status codes are retried depends on the `retryStatusCodes` generator configuration:
+
+**`legacy`** (current default): retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [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#server_error_responses) (All server errors, including 500)
 
+**`recommended`**: retries on
 - [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
 - [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)
+- [502](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) (Bad Gateway)
+- [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) (Service Unavailable)
+- [504](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) (Gateway Timeout)
 
 Use the `max_retries` request option to configure this behavior.
 
 ```python
-client.tts.audio.speech(..., request_options={
+client.audio.speech(..., request_options={
     "max_retries": 1
 })
 ```
@@ -101,17 +160,12 @@ client.tts.audio.speech(..., request_options={
 The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
 
 ```python
-
 from speechify import Speechify
 
-client = Speechify(
-    ...,
-    timeout=20.0,
-)
-
+client = Speechify(..., timeout=20.0)
 
 # Override timeout for a specific method
-client.tts.audio.speech(..., request_options={
+client.audio.speech(..., request_options={
     "timeout_in_seconds": 1
 })
 ```
@@ -120,6 +174,7 @@ client.tts.audio.speech(..., request_options={
 
 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 speechify import Speechify
@@ -127,7 +182,7 @@ from speechify import Speechify
 client = Speechify(
     ...,
     httpx_client=httpx.Client(
-        proxies="http://my.test.proxy.example.com",
+        proxy="http://my.test.proxy.example.com",
         transport=httpx.HTTPTransport(local_address="0.0.0.0"),
     ),
 )

speechify_api-1.2.4/pyproject.toml

@@ -0,0 +1,108 @@
+[project]
+name = "speechify-api"
+dynamic = ["version"]
+
+[tool.poetry]
+name = "speechify-api"
+version = "1.2.4"
+description = "Official Speechify API SDK"
+readme = "README.md"
+authors = [
+    "Speechify <support@speechify.com>"
+]
+keywords = [
+    "speechify",
+    "ai",
+    "api",
+    "sdk",
+    "text-to-speech",
+    "tts"
+]
+
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Operating System :: OS Independent",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed"
+]
+packages = [
+    { include = "speechify", from = "src"}
+]
+
+[tool.poetry.urls]
+Documentation = 'https://docs.speechify.ai/api-reference'
+Homepage = 'https://docs.speechify.ai'
+Repository = 'https://github.com/speechifyinc/speechify-api-sdk-python'
+
+[tool.poetry.dependencies]
+python = "^3.10"
+aiohttp = { version = ">=3.14.1,<4", optional = true, python = ">=3.10"}
+httpx = ">=0.21.2"
+httpx-aiohttp = { version = "0.1.8", optional = true, python = ">=3.10"}
+pydantic = ">= 1.9.2"
+pydantic-core = ">=2.18.2,<3.0.0"
+typing_extensions = ">= 4.0.0"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "==1.13.0"
+pytest = "^9.0.3"
+pytest-asyncio = "^1.0.0"
+pytest-xdist = "^3.6.1"
+python-dateutil = "^2.9.0"
+types-python-dateutil = "^2.9.0.20240316"
+urllib3 = ">=2.6.3,<3.0.0"
+ruff = "==0.11.5"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+norecursedirs = [ "src" ]
+markers = [
+    "aiohttp: tests that require httpx_aiohttp to be installed",
+]
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "F",  # pyflakes
+    "I",  # isort
+]
+ignore = [
+    "E402",  # Module level import not at top of file
+    "E501",  # Line too long
+    "E711",  # Comparison to `None` should be `cond is not None`
+    "E712",  # Avoid equality comparisons to `True`; use `if ...:` checks
+    "E721",  # Use `is` and `is not` for type comparisons, or `isinstance()` for insinstance checks
+    "E722",  # Do not use bare `except`
+    "E731",  # Do not assign a `lambda` expression, use a `def`
+    "F821",  # Undefined name
+    "F841"   # Local variable ... is assigned to but never used
+]
+
+[tool.ruff.lint.isort]
+section-order = ["future", "standard-library", "third-party", "first-party"]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.extras]
+aiohttp=["aiohttp", "httpx-aiohttp"]

speechify_api-1.2.4/src/speechify/__init__.py

@@ -0,0 +1,170 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import (
+        CreateVoiceLanguage,
+        CreateVoiceModel,
+        CreateVoiceModelName,
+        CreatedVoice,
+        CreatedVoiceGender,
+        CreatedVoiceType,
+        Error,
+        ErrorCode,
+        ErrorDetail,
+        GetSpeechOptionsRequest,
+        GetSpeechResponse,
+        GetSpeechResponseAudioFormat,
+        GetStreamOptionsRequest,
+        GetVoice,
+        GetVoiceGender,
+        GetVoiceLanguage,
+        GetVoiceType,
+        GetVoicesModel,
+        GetVoicesModelName,
+        NestedChunk,
+        SpeechMarks,
+    )
+    from .errors import (
+        BadGatewayError,
+        BadRequestError,
+        ForbiddenError,
+        InternalServerError,
+        NotFoundError,
+        PaymentRequiredError,
+        ServiceUnavailableError,
+        TooManyRequestsError,
+        UnauthorizedError,
+        UnprocessableEntityError,
+    )
+    from . import audio, voices
+    from ._default_clients import DefaultAioHttpClient, DefaultAsyncHttpxClient
+    from .audio import (
+        GetSpeechRequestAudioFormat,
+        GetSpeechRequestModel,
+        GetStreamRequestModel,
+        StreamAudioRequestAccept,
+    )
+    from .client import AsyncSpeechify, Speechify
+    from .environment import SpeechifyEnvironment
+    from .version import __version__
+    from .voices import CreateVoicesRequestGender
+_dynamic_imports: typing.Dict[str, str] = {
+    "AsyncSpeechify": ".client",
+    "BadGatewayError": ".errors",
+    "BadRequestError": ".errors",
+    "CreateVoiceLanguage": ".types",
+    "CreateVoiceModel": ".types",
+    "CreateVoiceModelName": ".types",
+    "CreateVoicesRequestGender": ".voices",
+    "CreatedVoice": ".types",
+    "CreatedVoiceGender": ".types",
+    "CreatedVoiceType": ".types",
+    "DefaultAioHttpClient": "._default_clients",
+    "DefaultAsyncHttpxClient": "._default_clients",
+    "Error": ".types",
+    "ErrorCode": ".types",
+    "ErrorDetail": ".types",
+    "ForbiddenError": ".errors",
+    "GetSpeechOptionsRequest": ".types",
+    "GetSpeechRequestAudioFormat": ".audio",
+    "GetSpeechRequestModel": ".audio",
+    "GetSpeechResponse": ".types",
+    "GetSpeechResponseAudioFormat": ".types",
+    "GetStreamOptionsRequest": ".types",
+    "GetStreamRequestModel": ".audio",
+    "GetVoice": ".types",
+    "GetVoiceGender": ".types",
+    "GetVoiceLanguage": ".types",
+    "GetVoiceType": ".types",
+    "GetVoicesModel": ".types",
+    "GetVoicesModelName": ".types",
+    "InternalServerError": ".errors",
+    "NestedChunk": ".types",
+    "NotFoundError": ".errors",
+    "PaymentRequiredError": ".errors",
+    "ServiceUnavailableError": ".errors",
+    "SpeechMarks": ".types",
+    "Speechify": ".client",
+    "SpeechifyEnvironment": ".environment",
+    "StreamAudioRequestAccept": ".audio",
+    "TooManyRequestsError": ".errors",
+    "UnauthorizedError": ".errors",
+    "UnprocessableEntityError": ".errors",
+    "__version__": ".version",
+    "audio": ".audio",
+    "voices": ".voices",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "AsyncSpeechify",
+    "BadGatewayError",
+    "BadRequestError",
+    "CreateVoiceLanguage",
+    "CreateVoiceModel",
+    "CreateVoiceModelName",
+    "CreateVoicesRequestGender",
+    "CreatedVoice",
+    "CreatedVoiceGender",
+    "CreatedVoiceType",
+    "DefaultAioHttpClient",
+    "DefaultAsyncHttpxClient",
+    "Error",
+    "ErrorCode",
+    "ErrorDetail",
+    "ForbiddenError",
+    "GetSpeechOptionsRequest",
+    "GetSpeechRequestAudioFormat",
+    "GetSpeechRequestModel",
+    "GetSpeechResponse",
+    "GetSpeechResponseAudioFormat",
+    "GetStreamOptionsRequest",
+    "GetStreamRequestModel",
+    "GetVoice",
+    "GetVoiceGender",
+    "GetVoiceLanguage",
+    "GetVoiceType",
+    "GetVoicesModel",
+    "GetVoicesModelName",
+    "InternalServerError",
+    "NestedChunk",
+    "NotFoundError",
+    "PaymentRequiredError",
+    "ServiceUnavailableError",
+    "SpeechMarks",
+    "Speechify",
+    "SpeechifyEnvironment",
+    "StreamAudioRequestAccept",
+    "TooManyRequestsError",
+    "UnauthorizedError",
+    "UnprocessableEntityError",
+    "__version__",
+    "audio",
+    "voices",
+]