# Wyoming OpenAI
OpenAI-Compatible Proxy Middleware for the Wyoming Protocol
**Author:** Rory Eckel
Note: This project is not affiliated with OpenAI or the Wyoming project.
## Overview
This project introduces a [Wyoming](https://github.com/OHF-Voice/wyoming) server that connects to OpenAI-compatible endpoints of your choice. Like a proxy, it enables Wyoming clients such as the [Home Assistant Wyoming Integration](https://www.home-assistant.io/integrations/wyoming/) to use the transcription (Automatic Speech Recognition - ASR) and text-to-speech synthesis (TTS) capabilities of various OpenAI-compatible projects. By acting as a bridge between the Wyoming protocol and OpenAI, you can consolidate the resource usage on your server and extend the capabilities of Home Assistant.
## Featured Models
This project features a variety of examples for using cutting-edge models in both Speech-to-Text (STT) and Text-to-Speech (TTS) scenarios:
- **`gpt-4o-transcribe`**: OpenAI's latest and most advanced model for highly accurate speech recognition.
- **`gpt-4o-mini-tts`**: A compact and efficient text-to-speech model from OpenAI, perfect for responsive vocalization.
- **`kokoro`**: A high-quality, open-source text-to-speech model, available for local deployment via [Speaches](#2-deploying-with-speaches-local-service) and [Kokoro-FastAPI](#3-deploying-with-kokoro-fastapi-and-speaches-local-services).
- **`whisper`**: The original renowned open-source transcription model from OpenAI, widely used for its accuracy and versatility.
## Objectives
1. **Wyoming Server, OpenAI-compatible Client**: Function as an intermediary between the Wyoming protocol and OpenAI's ASR and TTS services.
2. **Service Consolidation**: Allow users of various programs to run inference on a single server without needing separate instances for each service.
Example: Sharing TTS/STT services between [Open WebUI](#open-webui) and [Home Assistant](#usage-in-home-assistant).
3. **Asynchronous Processing**: Enable efficient handling of multiple requests by supporting asynchronous processing of audio streams.
4. **Simple Setup with Docker**: Provide a straightforward deployment process using [Docker and Docker Compose](#docker-recommended) for OpenAI and various popular open source projects.
## Terminology
- **TTS (Text-to-Speech)**: The process of converting text into audible speech output.
- **ASR (Automatic Speech Recognition) / STT (Speech-to-Text)**: Technologies that convert spoken language into written text. ASR and STT are often used interchangeably to describe this function.
## Installation (Local Development)
### Prerequisites
- Tested with Python 3.12
- Optional: OpenAI API key(s) if using proprietary models
### Instructions
1. **Clone the Repository**
```bash
git clone https://github.com/roryeckel/wyoming-openai.git
cd wyoming-openai
```
2. **Create a Virtual Environment** (optional but recommended)
```bash
python3 -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
3. **Install as a Development Package**
```bash
pip install -e .
```
Assuming you have activated a virtual environment, the wyoming_openai package will be installed into it. This will build and install the package in editable mode, allowing you to make changes to the code without needing to reinstall it each time.
Or, if you prefer to install it as a regular (production) package:
```bash
pip install .
```
This is more suitable for a global installation.
4. **Configure Environment Variables or Command Line Arguments**
## Installation from PyPI
Since v0.3.2, `wyoming-openai` is now available on [PyPI](https://pypi.org/project/wyoming-openai/). To install the latest release, run:
```bash
pip install wyoming-openai
```
This is useful for local deployment when you don't want to clone the repository or if you want to use the library components in your own projects.
To upgrade to the latest version, run:
```bash
pip install --upgrade wyoming-openai
```
## Command Line Arguments
The proxy server can be configured using several command line arguments to tailor its behavior to your specific needs.
### Example Usage
Assuming you have installed the package in your current environment, you can run the server with the following command:
```bash
python -m wyoming_openai \
--uri tcp://0.0.0.0:10300 \
--log-level INFO \
--languages en \
--stt-openai-key YOUR_STT_API_KEY_HERE \
--stt-openai-url https://api.openai.com/v1 \
--stt-models whisper-1 \
--stt-streaming-models gpt-4o-transcribe gpt-4o-mini-transcribe \
--stt-backend OPENAI \
--tts-openai-key YOUR_TTS_API_KEY_HERE \
--tts-openai-url https://api.openai.com/v1 \
--tts-models gpt-4o-mini-tts tts-1-hd tts-1 \
--tts-voices alloy ash coral echo fable onyx nova sage shimmer \
--tts-backend OPENAI \
--tts-speed 1.0
```
## Configuration Options
In addition to using command-line arguments, you can configure the Wyoming OpenAI proxy server via environment variables. This is especially useful for containerized deployments.
### Table of Environment & Command Line Options
| **Command Line Argument** | **Environment Variable** | **Default Value** | **Description** |
|-----------------------------------------|--------------------------------------------|-----------------------------------------------|----------------------------------------------------------------------|
| `--uri` | `WYOMING_URI` | tcp://0.0.0.0:10300 | The URI for the Wyoming server to bind to. |
| `--log-level` | `WYOMING_LOG_LEVEL` | INFO | Sets the logging level (e.g., INFO, DEBUG). |
| `--languages` | `WYOMING_LANGUAGES` | en | Space-separated list of supported languages to advertise. |
| `--stt-openai-key` | `STT_OPENAI_KEY` | None | Optional API key for OpenAI-compatible speech-to-text services. |
| `--stt-openai-url` | `STT_OPENAI_URL` | https://api.openai.com/v1 | The base URL for the OpenAI-compatible speech-to-text API |
| `--stt-models` | `STT_MODELS` | None (required*) | Space-separated list of models to use for the STT service. Example: `gpt-4o-transcribe gpt-4o-mini-transcribe whisper-1` |
| `--stt-streaming-models` | `STT_STREAMING_MODELS` | None | Space-separated list of STT models that support streaming (e.g. `gpt-4o-transcribe gpt-4o-mini-transcribe`). Only these models will use streaming mode. |
| `--stt-backend` | `STT_BACKEND` | None (autodetected) | Enable unofficial API feature sets. |
| `--stt-temperature` | `STT_TEMPERATURE` | None (autodetected) | Sampling temperature for speech-to-text (ranges from 0.0 to 1.0) |
| `--stt-prompt` | `STT_PROMPT` | None | Optional prompt for STT requests (Text to guide the model's style). |
| `--tts-openai-key` | `TTS_OPENAI_KEY` | None | Optional API key for OpenAI-compatible text-to-speech services. |
| `--tts-openai-url` | `TTS_OPENAI_URL` | https://api.openai.com/v1 | The base URL for the OpenAI-compatible text-to-speech API |
| `--tts-models` | `TTS_MODELS` | None (required*) | Space-separated list of models to use for the TTS service. Example: `gpt-4o-mini-tts tts-1-hd tts-1` |
| `--tts-voices` | `TTS_VOICES` | Empty (autodetected) | Space-separated list of voices for TTS. |
| `--tts-backend` | `TTS_BACKEND` | None (autodetected) | Enable unofficial API feature sets. |
| `--tts-speed` | `TTS_SPEED` | None (autodetected) | Speed of the TTS output (ranges from 0.25 to 4.0). |
| `--tts-instructions` | `TTS_INSTRUCTIONS` | None | Optional instructions for TTS requests (Control the voice). |
## Docker (Recommended)
### Prerequisites
- Ensure you have [Docker](https://www.docker.com/products/docker-desktop) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your system.
### Deployment Options
You can deploy the Wyoming OpenAI proxy server in different environments depending on whether you are using official OpenAI services or a local alternative like Speaches. You can even run multiple wyoming_openai instances on different ports for different purposes. Below are example scenarios:
#### 1. Deploying with Official OpenAI Services
To set up the Wyoming OpenAI proxy to work with official OpenAI APIs, follow these steps:
- **Environment Variables**: Create a `.env` file in your project directory that includes necessary environment variables such as `STT_OPENAI_KEY`, `TTS_OPENAI_KEY`.
- **Docker Compose Configuration**: Use the provided `docker-compose.yml` template. This setup binds a Wyoming server to port 10300 and uses environment variables for OpenAI URLs, model configurations, and voices as specified in the compose file.
- **Command**:
```bash
docker compose -f docker-compose.yml up -d
```
#### 2. Deploying with Speaches Local Service
If you prefer using a local service like Speaches instead of official OpenAI services, follow these instructions:
- **Docker Compose Configuration**: Use the `docker-compose.speaches.yml` template which includes configuration for both the Wyoming OpenAI proxy and the Speaches service.
- **Speaches Setup**:
- The Speaches container is configured with specific model settings (`Systran/faster-distil-whisper-large-v3` for STT and `speaches-ai/Kokoro-82M-v1.0-ONNX` for TTS).
- It uses a local port (8000) to expose the Speaches service.
- NVIDIA GPU support is enabled, so ensure your system has an appropriate setup if you plan to utilize GPU resources.
- Note: wyoming_openai disables Speaches VAD (Voice Activity Detection) by default, as it is not yet compatible with the Wyoming protocol.
- **Command**:
```bash
docker compose -f docker-compose.speaches.yml up -d
```
#### 3. Deploying with Kokoro-FastAPI and Speaches Local Services
For users preferring a setup that leverages Kokoro-FastAPI for TTS and Speaches for STT, follow these instructions:
- **Docker Compose Configuration**: Use the `docker-compose.kokoro-fastapi.yml` template which includes configuration for both the Wyoming OpenAI proxy and Kokoro-FastAPI TTS service (Kokoro).
- **Speaches Setup**:
- Use it in combination with the Speaches container for access to STT.
- **Kokoro Setup**:
- The Kokoro-FastAPI container provides TTS capabilities.
- It uses a local port (8880) to expose the Kokoro service.
- NVIDIA GPU support is enabled, so ensure your system has an appropriate setup if you plan to utilize GPU resources.
- **Command**:
```bash
docker compose -f docker-compose.speaches.yml -f docker-compose.kokoro-fastapi.yml up -d
```
#### 4. Development with Docker
If you are developing the Wyoming OpenAI proxy server and want to build it from source, use the `docker-compose.dev.yml` file along with the base configuration.
- **Command**:
```bash
docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build
```
#### 5. Example: Development with Additional Local Service
For a development setup using the Speaches local service, combine `docker-compose.speaches.yml` and `docker-compose.dev.yml`. This also works for `docker-compose.kokoro-fastapi.yml`.
- **Command**:
```bash
docker compose -f docker-compose.speaches.yml -f docker-compose.dev.yml up -d --build
```
#### 6. Docker Tags
We follow specific tagging conventions for our Docker images. These tags help in identifying the version and branch of the code that a particular Docker image is based on.
- **`latest`**: This tag always points to the latest stable release of the Wyoming OpenAI proxy server. It is recommended for users who want to run the most recent, well-tested version without worrying about specific versions.
- **`main`**: This tag points to the latest commit on the main code branch. It is suitable for users who want to experiment with the most up-to-date features and changes, but may include unstable or experimental code.
- **`major.minor.patch version`**: Specific version tags (e.g., `0.3.4`) correspond to specific stable releases of the Wyoming OpenAI proxy server. These tags are ideal for users who need a consistent, reproducible environment and want to avoid breaking changes introduced in newer versions.
- **`major.minor version`**: Tags that follow the `major.minor` format (e.g., `0.3`) represent a range of patch-level updates within the same minor version series. These tags are useful for users who want to stay updated with bug fixes and minor improvements without upgrading to a new major or minor version.
### General Deployment Steps
1. **Start Services**: Run the appropriate Docker Compose command based on your deployment option.
2. **Verify Deployment**: Ensure that all services are running by checking the logs with `docker compose logs -f` or accessing the Wyoming OpenAI proxy through its exposed port (e.g., 10300) to ensure it responds as expected.
3. **Configuration Changes**: You can modify environment variables in the `.env` file or directly within your Docker Compose configuration files to adjust settings such as languages, models, and voices without rebuilding containers.
## Usage in Home Assistant
1. Install & set up your Wyoming OpenAI instance using one of the [deployment options](#deployment-options) above.
2. In HA, Go to Settings, Devices & Services, Add Integration, and search for Wyoming Protocol. Add the Wyoming Protocol integration with the URI of your Wyoming OpenAI instance.
3. The hard part is over! Configure your Voice Assistant pipeline to use the STT/TTS services provided by your new Wyoming OpenAI instance.
#### Reloading Configuration Changes in Home Assistant
When you make changes to your configuration such as updating models, voices, or URLs, it's important to reload the Wyoming OpenAI integration in Home Assistant to apply these changes. Here's how to do it:
1. Go to **Settings** > **Devices & Services**
2. Find and select your **Wyoming OpenAI** integration
3. Click on **Reload**
### Sequence Diagrams
#### Home Assistant
Home Assistant uses the Wyoming Protocol integration to communicate with the Wyoming OpenAI proxy server. The proxy server then communicates with the OpenAI API to perform the requested ASR or TTS tasks. The results are then sent back to Home Assistant.
```mermaid
sequenceDiagram
participant HA as Home Assistant
participant WY as wyoming_openai
participant OAPI as OpenAI API
Note over HA,OAPI: Speech-to-Text (STT/ASR) Flow
HA->>WY: Transcribe event
HA->>WY: AudioStart event
loop Audio Streaming
HA->>WY: AudioChunk events
Note over WY: Buffers WAV data
end
HA->>WY: AudioStop event
alt Non-Streaming Transcription
WY->>OAPI: Send complete audio file
OAPI-->>WY: Text transcript response
WY->>HA: TranscriptStart event
WY->>HA: Transcript event (complete text)
WY->>HA: TranscriptStop event
else Streaming Transcription
WY->>OAPI: Send audio file with stream=true
WY->>HA: TranscriptStart event
loop
OAPI-->>WY: Transcript chunk delta
WY-->>HA: TranscriptChunk event (partial text)
end
WY->>HA: Transcript event (complete text)
WY->>HA: TranscriptStop event
end
Note over HA,OAPI: Text-to-Speech (TTS) Flow
HA->>WY: Synthesize event (text + voice)
WY->>OAPI: Speech synthesis request
WY->>HA: AudioStart event
loop Audio Streaming
OAPI-->>WY: Audio stream chunks
WY-->>HA: AudioChunk events
end
WY->>HA: AudioStop event
```
#### Open WebUI
No proxy is needed for Open WebUI, because it has native support for OpenAI-compatible endpoints.
```mermaid
sequenceDiagram
participant OW as Open WebUI
participant OAPI as OpenAI API
Note over OW,OAPI: Speech-to-Text (STT/ASR) Flow
OW->>OAPI: Direct audio transcription request
OAPI-->>OW: Text transcript response
Note over OW,OAPI: Text-to-Speech (TTS) Flow
OW->>OAPI: Direct speech synthesis request
OAPI-->>OW: Audio stream response
```
## Future Plans (Descending Priority)
- Improved streaming support directly to OpenAI APIs
- Reverse direction support (Server for OpenAI compatible endpoints - possibly FastAPI)
- OpenAI Realtime API
## Contributing
Contributions are welcome! Please feel free to open issues or submit pull requests. For major changes, please first discuss the proposed changes in an issue.
## Quality Assurance
### Linting (Ruff)
This project uses [Ruff](https://github.com/astral-sh/ruff) for linting and code quality checks. Ruff is a fast Python linter written in Rust that can replace multiple tools like flake8, isort, and more.
To use Ruff during development:
1. Install development dependencies:
```bash
pip install -e ".[dev]"
```
2. Run Ruff to check your code:
```bash
ruff check .
```
A GitHub Action automatically runs Ruff on all pull requests and branch pushes to ensure code quality.
### Testing (Pytest)
This project uses [pytest](https://pytest.org/) for unit testing. Tests are located in the [`tests/`](tests/) directory and cover core modules such as compatibility, constants, handlers, initialization, and utilities.
To run the tests:
1. Install development dependencies (if not already done):
```bash
pip install -e ".[dev]"
```
2. In the [`tests/`](tests/) folder, run all tests with:
```bash
pytest
```
All new code should include appropriate tests.
A GitHub Action automatically runs pytest on all pull requests and branch pushes to ensure tests pass.
Raw data
{
"_id": null,
"home_page": null,
"name": "wyoming-openai",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "proxy, tts, openai, home-assistant, stt, asr, wyoming",
"author": "Rory Eckel",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/10/d4/56d2973188714939f819ea0a424cc51264a1f611c8af96479126e161b34a/wyoming_openai-0.3.4.tar.gz",
"platform": null,
"description": "# Wyoming OpenAI\n\nOpenAI-Compatible Proxy Middleware for the Wyoming Protocol\n\n**Author:** Rory Eckel\n\nNote: This project is not affiliated with OpenAI or the Wyoming project.\n\n## Overview\n\nThis project introduces a [Wyoming](https://github.com/OHF-Voice/wyoming) server that connects to OpenAI-compatible endpoints of your choice. Like a proxy, it enables Wyoming clients such as the [Home Assistant Wyoming Integration](https://www.home-assistant.io/integrations/wyoming/) to use the transcription (Automatic Speech Recognition - ASR) and text-to-speech synthesis (TTS) capabilities of various OpenAI-compatible projects. By acting as a bridge between the Wyoming protocol and OpenAI, you can consolidate the resource usage on your server and extend the capabilities of Home Assistant.\n\n## Featured Models\n\nThis project features a variety of examples for using cutting-edge models in both Speech-to-Text (STT) and Text-to-Speech (TTS) scenarios:\n\n- **`gpt-4o-transcribe`**: OpenAI's latest and most advanced model for highly accurate speech recognition.\n- **`gpt-4o-mini-tts`**: A compact and efficient text-to-speech model from OpenAI, perfect for responsive vocalization.\n- **`kokoro`**: A high-quality, open-source text-to-speech model, available for local deployment via [Speaches](#2-deploying-with-speaches-local-service) and [Kokoro-FastAPI](#3-deploying-with-kokoro-fastapi-and-speaches-local-services).\n- **`whisper`**: The original renowned open-source transcription model from OpenAI, widely used for its accuracy and versatility.\n## Objectives\n\n1. **Wyoming Server, OpenAI-compatible Client**: Function as an intermediary between the Wyoming protocol and OpenAI's ASR and TTS services.\n2. **Service Consolidation**: Allow users of various programs to run inference on a single server without needing separate instances for each service.\nExample: Sharing TTS/STT services between [Open WebUI](#open-webui) and [Home Assistant](#usage-in-home-assistant).\n3. **Asynchronous Processing**: Enable efficient handling of multiple requests by supporting asynchronous processing of audio streams.\n4. **Simple Setup with Docker**: Provide a straightforward deployment process using [Docker and Docker Compose](#docker-recommended) for OpenAI and various popular open source projects.\n\n## Terminology\n\n- **TTS (Text-to-Speech)**: The process of converting text into audible speech output.\n- **ASR (Automatic Speech Recognition) / STT (Speech-to-Text)**: Technologies that convert spoken language into written text. ASR and STT are often used interchangeably to describe this function.\n\n## Installation (Local Development)\n\n### Prerequisites\n\n- Tested with Python 3.12\n- Optional: OpenAI API key(s) if using proprietary models\n\n### Instructions\n\n1. **Clone the Repository**\n\n ```bash\n git clone https://github.com/roryeckel/wyoming-openai.git\n cd wyoming-openai\n ```\n\n2. **Create a Virtual Environment** (optional but recommended)\n\n ```bash\n python3 -m venv venv\n source venv/bin/activate # On Windows use `venv\\Scripts\\activate`\n ```\n\n3. **Install as a Development Package**\n\n ```bash\n pip install -e .\n ```\n Assuming you have activated a virtual environment, the wyoming_openai package will be installed into it. This will build and install the package in editable mode, allowing you to make changes to the code without needing to reinstall it each time.\n\n Or, if you prefer to install it as a regular (production) package:\n\n ```bash\n pip install .\n ```\n\n This is more suitable for a global installation.\n\n4. **Configure Environment Variables or Command Line Arguments**\n\n## Installation from PyPI\n\nSince v0.3.2, `wyoming-openai` is now available on [PyPI](https://pypi.org/project/wyoming-openai/). To install the latest release, run:\n\n```bash\npip install wyoming-openai\n```\n\nThis is useful for local deployment when you don't want to clone the repository or if you want to use the library components in your own projects.\n\nTo upgrade to the latest version, run:\n\n```bash\npip install --upgrade wyoming-openai\n```\n\n## Command Line Arguments\n\nThe proxy server can be configured using several command line arguments to tailor its behavior to your specific needs.\n\n### Example Usage\n\nAssuming you have installed the package in your current environment, you can run the server with the following command:\n\n```bash\npython -m wyoming_openai \\\n --uri tcp://0.0.0.0:10300 \\\n --log-level INFO \\\n --languages en \\\n --stt-openai-key YOUR_STT_API_KEY_HERE \\\n --stt-openai-url https://api.openai.com/v1 \\\n --stt-models whisper-1 \\\n --stt-streaming-models gpt-4o-transcribe gpt-4o-mini-transcribe \\\n --stt-backend OPENAI \\\n --tts-openai-key YOUR_TTS_API_KEY_HERE \\\n --tts-openai-url https://api.openai.com/v1 \\\n --tts-models gpt-4o-mini-tts tts-1-hd tts-1 \\\n --tts-voices alloy ash coral echo fable onyx nova sage shimmer \\\n --tts-backend OPENAI \\\n --tts-speed 1.0\n```\n\n## Configuration Options\n\nIn addition to using command-line arguments, you can configure the Wyoming OpenAI proxy server via environment variables. This is especially useful for containerized deployments.\n\n### Table of Environment & Command Line Options\n\n| **Command Line Argument** | **Environment Variable** | **Default Value** | **Description** |\n|-----------------------------------------|--------------------------------------------|-----------------------------------------------|----------------------------------------------------------------------|\n| `--uri` | `WYOMING_URI` | tcp://0.0.0.0:10300 | The URI for the Wyoming server to bind to. |\n| `--log-level` | `WYOMING_LOG_LEVEL` | INFO | Sets the logging level (e.g., INFO, DEBUG). |\n| `--languages` | `WYOMING_LANGUAGES` | en | Space-separated list of supported languages to advertise. |\n| `--stt-openai-key` | `STT_OPENAI_KEY` | None | Optional API key for OpenAI-compatible speech-to-text services. |\n| `--stt-openai-url` | `STT_OPENAI_URL` | https://api.openai.com/v1 | The base URL for the OpenAI-compatible speech-to-text API |\n| `--stt-models` | `STT_MODELS` | None (required*) | Space-separated list of models to use for the STT service. Example: `gpt-4o-transcribe gpt-4o-mini-transcribe whisper-1` |\n| `--stt-streaming-models` | `STT_STREAMING_MODELS` | None | Space-separated list of STT models that support streaming (e.g. `gpt-4o-transcribe gpt-4o-mini-transcribe`). Only these models will use streaming mode. |\n| `--stt-backend` | `STT_BACKEND` | None (autodetected) | Enable unofficial API feature sets. |\n| `--stt-temperature` | `STT_TEMPERATURE` | None (autodetected) | Sampling temperature for speech-to-text (ranges from 0.0 to 1.0) |\n| `--stt-prompt` | `STT_PROMPT` | None | Optional prompt for STT requests (Text to guide the model's style). |\n| `--tts-openai-key` | `TTS_OPENAI_KEY` | None | Optional API key for OpenAI-compatible text-to-speech services. |\n| `--tts-openai-url` | `TTS_OPENAI_URL` | https://api.openai.com/v1 | The base URL for the OpenAI-compatible text-to-speech API |\n| `--tts-models` | `TTS_MODELS` | None (required*) | Space-separated list of models to use for the TTS service. Example: `gpt-4o-mini-tts tts-1-hd tts-1` |\n| `--tts-voices` | `TTS_VOICES` | Empty (autodetected) | Space-separated list of voices for TTS. |\n| `--tts-backend` | `TTS_BACKEND` | None (autodetected) | Enable unofficial API feature sets. |\n| `--tts-speed` | `TTS_SPEED` | None (autodetected) | Speed of the TTS output (ranges from 0.25 to 4.0). |\n| `--tts-instructions` | `TTS_INSTRUCTIONS` | None | Optional instructions for TTS requests (Control the voice). |\n\n## Docker (Recommended)\n\n### Prerequisites\n\n- Ensure you have [Docker](https://www.docker.com/products/docker-desktop) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your system.\n\n### Deployment Options\n\nYou can deploy the Wyoming OpenAI proxy server in different environments depending on whether you are using official OpenAI services or a local alternative like Speaches. You can even run multiple wyoming_openai instances on different ports for different purposes. Below are example scenarios:\n\n#### 1. Deploying with Official OpenAI Services\n\nTo set up the Wyoming OpenAI proxy to work with official OpenAI APIs, follow these steps:\n\n- **Environment Variables**: Create a `.env` file in your project directory that includes necessary environment variables such as `STT_OPENAI_KEY`, `TTS_OPENAI_KEY`.\n\n- **Docker Compose Configuration**: Use the provided `docker-compose.yml` template. This setup binds a Wyoming server to port 10300 and uses environment variables for OpenAI URLs, model configurations, and voices as specified in the compose file.\n\n- **Command**:\n \n ```bash\n docker compose -f docker-compose.yml up -d\n ```\n\n#### 2. Deploying with Speaches Local Service\n\nIf you prefer using a local service like Speaches instead of official OpenAI services, follow these instructions:\n\n- **Docker Compose Configuration**: Use the `docker-compose.speaches.yml` template which includes configuration for both the Wyoming OpenAI proxy and the Speaches service.\n\n- **Speaches Setup**:\n - The Speaches container is configured with specific model settings (`Systran/faster-distil-whisper-large-v3` for STT and `speaches-ai/Kokoro-82M-v1.0-ONNX` for TTS).\n - It uses a local port (8000) to expose the Speaches service.\n - NVIDIA GPU support is enabled, so ensure your system has an appropriate setup if you plan to utilize GPU resources.\n - Note: wyoming_openai disables Speaches VAD (Voice Activity Detection) by default, as it is not yet compatible with the Wyoming protocol.\n\n- **Command**:\n \n ```bash\n docker compose -f docker-compose.speaches.yml up -d\n ```\n\n#### 3. Deploying with Kokoro-FastAPI and Speaches Local Services\n\nFor users preferring a setup that leverages Kokoro-FastAPI for TTS and Speaches for STT, follow these instructions:\n\n- **Docker Compose Configuration**: Use the `docker-compose.kokoro-fastapi.yml` template which includes configuration for both the Wyoming OpenAI proxy and Kokoro-FastAPI TTS service (Kokoro).\n\n- **Speaches Setup**:\n - Use it in combination with the Speaches container for access to STT.\n\n- **Kokoro Setup**:\n - The Kokoro-FastAPI container provides TTS capabilities.\n - It uses a local port (8880) to expose the Kokoro service.\n - NVIDIA GPU support is enabled, so ensure your system has an appropriate setup if you plan to utilize GPU resources.\n\n- **Command**:\n\n ```bash\n docker compose -f docker-compose.speaches.yml -f docker-compose.kokoro-fastapi.yml up -d\n ```\n\n#### 4. Development with Docker\n\nIf you are developing the Wyoming OpenAI proxy server and want to build it from source, use the `docker-compose.dev.yml` file along with the base configuration.\n\n- **Command**:\n \n ```bash\n docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build\n ```\n\n#### 5. Example: Development with Additional Local Service\n\nFor a development setup using the Speaches local service, combine `docker-compose.speaches.yml` and `docker-compose.dev.yml`. This also works for `docker-compose.kokoro-fastapi.yml`.\n\n- **Command**:\n \n ```bash\n docker compose -f docker-compose.speaches.yml -f docker-compose.dev.yml up -d --build\n ```\n\n#### 6. Docker Tags\n\nWe follow specific tagging conventions for our Docker images. These tags help in identifying the version and branch of the code that a particular Docker image is based on.\n\n- **`latest`**: This tag always points to the latest stable release of the Wyoming OpenAI proxy server. It is recommended for users who want to run the most recent, well-tested version without worrying about specific versions.\n\n- **`main`**: This tag points to the latest commit on the main code branch. It is suitable for users who want to experiment with the most up-to-date features and changes, but may include unstable or experimental code.\n\n- **`major.minor.patch version`**: Specific version tags (e.g., `0.3.4`) correspond to specific stable releases of the Wyoming OpenAI proxy server. These tags are ideal for users who need a consistent, reproducible environment and want to avoid breaking changes introduced in newer versions.\n\n- **`major.minor version`**: Tags that follow the `major.minor` format (e.g., `0.3`) represent a range of patch-level updates within the same minor version series. These tags are useful for users who want to stay updated with bug fixes and minor improvements without upgrading to a new major or minor version.\n\n### General Deployment Steps\n\n1. **Start Services**: Run the appropriate Docker Compose command based on your deployment option.\n2. **Verify Deployment**: Ensure that all services are running by checking the logs with `docker compose logs -f` or accessing the Wyoming OpenAI proxy through its exposed port (e.g., 10300) to ensure it responds as expected.\n3. **Configuration Changes**: You can modify environment variables in the `.env` file or directly within your Docker Compose configuration files to adjust settings such as languages, models, and voices without rebuilding containers.\n\n## Usage in Home Assistant\n\n1. Install & set up your Wyoming OpenAI instance using one of the [deployment options](#deployment-options) above.\n2. In HA, Go to Settings, Devices & Services, Add Integration, and search for Wyoming Protocol. Add the Wyoming Protocol integration with the URI of your Wyoming OpenAI instance.\n3. The hard part is over! Configure your Voice Assistant pipeline to use the STT/TTS services provided by your new Wyoming OpenAI instance.\n\n#### Reloading Configuration Changes in Home Assistant\n\nWhen you make changes to your configuration such as updating models, voices, or URLs, it's important to reload the Wyoming OpenAI integration in Home Assistant to apply these changes. Here's how to do it:\n\n1. Go to **Settings** > **Devices & Services**\n2. Find and select your **Wyoming OpenAI** integration\n3. Click on **Reload**\n\n### Sequence Diagrams\n\n#### Home Assistant\n\nHome Assistant uses the Wyoming Protocol integration to communicate with the Wyoming OpenAI proxy server. The proxy server then communicates with the OpenAI API to perform the requested ASR or TTS tasks. The results are then sent back to Home Assistant.\n\n```mermaid\nsequenceDiagram\n participant HA as Home Assistant\n participant WY as wyoming_openai\n participant OAPI as OpenAI API\n Note over HA,OAPI: Speech-to-Text (STT/ASR) Flow\n HA->>WY: Transcribe event\n HA->>WY: AudioStart event\n loop Audio Streaming\n HA->>WY: AudioChunk events\n Note over WY: Buffers WAV data\n end\n HA->>WY: AudioStop event\n \n alt Non-Streaming Transcription\n WY->>OAPI: Send complete audio file\n OAPI-->>WY: Text transcript response\n WY->>HA: TranscriptStart event\n WY->>HA: Transcript event (complete text)\n WY->>HA: TranscriptStop event\n else Streaming Transcription\n WY->>OAPI: Send audio file with stream=true\n WY->>HA: TranscriptStart event\n loop\n OAPI-->>WY: Transcript chunk delta\n WY-->>HA: TranscriptChunk event (partial text)\n end\n WY->>HA: Transcript event (complete text)\n WY->>HA: TranscriptStop event\n end\n \n Note over HA,OAPI: Text-to-Speech (TTS) Flow\n HA->>WY: Synthesize event (text + voice)\n WY->>OAPI: Speech synthesis request\n WY->>HA: AudioStart event\n loop Audio Streaming\n OAPI-->>WY: Audio stream chunks\n WY-->>HA: AudioChunk events\n end\n WY->>HA: AudioStop event\n```\n\n#### Open WebUI\n\nNo proxy is needed for Open WebUI, because it has native support for OpenAI-compatible endpoints.\n\n```mermaid\nsequenceDiagram\n participant OW as Open WebUI\n participant OAPI as OpenAI API\n\n Note over OW,OAPI: Speech-to-Text (STT/ASR) Flow\n OW->>OAPI: Direct audio transcription request\n OAPI-->>OW: Text transcript response\n \n Note over OW,OAPI: Text-to-Speech (TTS) Flow\n OW->>OAPI: Direct speech synthesis request\n OAPI-->>OW: Audio stream response\n \n```\n\n## Future Plans (Descending Priority)\n\n- Improved streaming support directly to OpenAI APIs\n- Reverse direction support (Server for OpenAI compatible endpoints - possibly FastAPI)\n- OpenAI Realtime API\n\n## Contributing\n\nContributions are welcome! Please feel free to open issues or submit pull requests. For major changes, please first discuss the proposed changes in an issue.\n\n## Quality Assurance\n\n### Linting (Ruff)\n\nThis project uses [Ruff](https://github.com/astral-sh/ruff) for linting and code quality checks. Ruff is a fast Python linter written in Rust that can replace multiple tools like flake8, isort, and more.\n\nTo use Ruff during development:\n\n1. Install development dependencies:\n ```bash\n pip install -e \".[dev]\"\n ```\n\n2. Run Ruff to check your code:\n ```bash\n ruff check .\n ```\n\nA GitHub Action automatically runs Ruff on all pull requests and branch pushes to ensure code quality.\n\n### Testing (Pytest)\n\nThis project uses [pytest](https://pytest.org/) for unit testing. Tests are located in the [`tests/`](tests/) directory and cover core modules such as compatibility, constants, handlers, initialization, and utilities.\n\nTo run the tests:\n\n1. Install development dependencies (if not already done):\n ```bash\n pip install -e \".[dev]\"\n ```\n\n2. In the [`tests/`](tests/) folder, run all tests with:\n ```bash\n pytest\n ```\n\nAll new code should include appropriate tests.\nA GitHub Action automatically runs pytest on all pull requests and branch pushes to ensure tests pass.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "OpenAI-Compatible Proxy Middleware for the Wyoming Protocol",
"version": "0.3.4",
"project_urls": {
"Homepage": "https://github.com/roryeckel/wyoming_openai",
"Issues": "https://github.com/roryeckel/wyoming_openai/issues"
},
"split_keywords": [
"proxy",
" tts",
" openai",
" home-assistant",
" stt",
" asr",
" wyoming"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a2811484c7bc251a7afcf5e4fb67a3d9310c77c43f64f270873e30427042324b",
"md5": "97792b0d909974e99b3a751f37de23d7",
"sha256": "2052bd771288482d1d4359bfdcd0375b32b82311e3507f421c84c846164c1b25"
},
"downloads": -1,
"filename": "wyoming_openai-0.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "97792b0d909974e99b3a751f37de23d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 23150,
"upload_time": "2025-07-16T00:18:57",
"upload_time_iso_8601": "2025-07-16T00:18:57.078624Z",
"url": "https://files.pythonhosted.org/packages/a2/81/1484c7bc251a7afcf5e4fb67a3d9310c77c43f64f270873e30427042324b/wyoming_openai-0.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "10d456d2973188714939f819ea0a424cc51264a1f611c8af96479126e161b34a",
"md5": "abf9676e238d194884ed3cfda72df0e0",
"sha256": "1dc64095d4e873f6f51c880317df2cab5e9e7df00763043b1d9108b5451fb562"
},
"downloads": -1,
"filename": "wyoming_openai-0.3.4.tar.gz",
"has_sig": false,
"md5_digest": "abf9676e238d194884ed3cfda72df0e0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 28980,
"upload_time": "2025-07-16T00:18:58",
"upload_time_iso_8601": "2025-07-16T00:18:58.402090Z",
"url": "https://files.pythonhosted.org/packages/10/d4/56d2973188714939f819ea0a424cc51264a1f611c8af96479126e161b34a/wyoming_openai-0.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-16 00:18:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "roryeckel",
"github_project": "wyoming_openai",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wyoming-openai"
}
JSON
