(2.0.0) woohoo, first major version bump!
Some checks failed
Actions / build (push) Successful in 8s
Actions / lint (push) Failing after 13s
Actions / docs (push) Successful in 23s

bunch of stuff this update, including a full documentation site (still a WIP)
there is now a cache created whenever an instance of `FloweryAPI` is instantiated, so you don't have to query the api and iterate through the api response to retrieve a single voice anymore!
function names have also been changed with this update, hence the major version bump. `get_tts()`, `get_voices()`, and `get_voice()` have been renamed to `fetch_tts()`, `fetch_voices()`, and `fetch_voice()` respectively. `get_voices()` still exists, but with different functionality (that method retrieves voices from the internal cache instead of querying the flowery api)

!BREAKING
This commit is contained in:
cswimr 2024-09-18 09:55:25 -04:00
parent 81dea4c8a2
commit cb87400278
Signed by: cswimr
GPG key ID: 3813315477F26F82
17 changed files with 1489 additions and 36 deletions

View file

@ -35,6 +35,12 @@ class RestAdapter:
params (dict): Python dictionary of query parameters to send with the request.
timeout (float): Number of seconds to wait for the request to complete.
Raises:
TooManyRequests: Raised when the Flowery API returns a 429 status code
ClientError: Raised when the Flowery API returns a 4xx status code
InternalServerError: Raised when the Flowery API returns a 5xx status code
RetryLimitExceeded: Raised when the retry limit defined in the `FloweryAPIConfig` class (default 3) is exceeded
Returns:
Result: A Result object containing the status code, message, and data from the request.
"""
@ -86,6 +92,12 @@ class RestAdapter:
params (dict): Python dictionary of query parameters to send with the request.
timeout (float): Number of seconds to wait for the request to complete.
Raises:
TooManyRequests: Raised when the Flowery API returns a 429 status code
ClientError: Raised when the Flowery API returns a 4xx status code
InternalServerError: Raised when the Flowery API returns a 5xx status code
RetryLimitExceeded: Raised when the retry limit defined in the `FloweryAPIConfig` class (default 3) is exceeded
Returns:
Result: A Result object containing the status code, message, and data from the request.
"""