(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

@ -0,0 +1,29 @@
# Installation
This section will guide you through the installation process of PyFlowery.
## pip
You can use pip to install PyFlowery.
The command to use differs slightly depending on what operating system you use.
On Windows:
``` prolog title="Command Prompt"
py -m pip install pyflowery
```
On macOS and Linux:
``` prolog title="Bash"
python3 -m pip install pyflowery
```
## Poetry
You can also use [Poetry](https://python-poetry.org/) to store your dependencies.
Use the following command to install PyFlowery:
``` prolog title="Command Prompt / Shell"
poetry add pyflowery
```

View file

BIN
docs/img/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 526 KiB

11
docs/index.md Normal file
View file

@ -0,0 +1,11 @@
# Welcome to PyFlowery
/// admonition | This project is in active development
type: warning
These docs are not complete yet, and there is a lot still to do.
///
**PyFlowery** is a Python API Wrapper for the [Flowery](https://flowery.pw/about) API.
Check out the [usage](getting-started/usage.md) section for further information.
Installation instructions can be found [here](getting-started/installation.md).

3
docs/ref/exceptions.md Normal file
View file

@ -0,0 +1,3 @@
# Exceptions
::: pyflowery.exceptions

3
docs/ref/flowery.md Normal file
View file

@ -0,0 +1,3 @@
# FloweryAPI
::: pyflowery.pyflowery

3
docs/ref/models.md Normal file
View file

@ -0,0 +1,3 @@
# Models Reference
::: pyflowery.models

9
docs/ref/rest_adapter.md Normal file
View file

@ -0,0 +1,9 @@
# Rest Adapter
/// admonition | Internal Functions
type: warning
These functions are meant for use in other parts of the module. You *probably* shouldn't be calling these manually.
If there's an endpoint method missing from the main [FloweryAPI](flowery.md) class, you should open an [issue](https://www.coastalcommits.com/cswimr/PyFlowery/issues) (or a [pull request](https://www.coastalcommits.com/cswimr/PyFlowery/pulls)).
///
::: pyflowery.rest_adapter