wyoming-openai 0.3.2__tar.gz

wyoming_openai-0.3.2/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

wyoming_openai-0.3.2/PKG-INFO

@@ -0,0 +1,330 @@
+Metadata-Version: 2.4
+Name: wyoming_openai
+Version: 0.3.2
+Summary: OpenAI-Compatible Proxy Middleware for the Wyoming Protocol
+Author: Rory Eckel
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/roryeckel/wyoming_openai
+Project-URL: Issues, https://github.com/roryeckel/wyoming_openai/issues
+Keywords: proxy,tts,openai,home-assistant,stt,asr,wyoming
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: openai==1.86.0
+Requires-Dist: wyoming==1.6.1
+Provides-Extra: dev
+Requires-Dist: ruff==0.11.10; extra == "dev"
+Dynamic: license-file
+
+# 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/rhasspy/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.
+
+## 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**
+
+## 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 gpt-4o-transcribe gpt-4o-mini-transcribe whisper-1 \
+  --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`                               | gpt-4o-transcribe gpt-4o-mini-transcribe whisper-1            | Space-separated list of models to use for the STT service.           |
+| `--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`                               | gpt-4o-mini-tts tts-1-hd tts-1                                | Space-separated list of models to use for the TTS service.           |
+| `--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.
+
+- **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.1`) 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.2`) 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
+  WY->>OAPI: Send complete audio file
+  OAPI-->>WY: Text transcript response
+  WY-->>HA: Transcript event
+  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.
+
+## Linting and Code Quality (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 .
+   ```
+
+The project includes a GitHub Action that automatically runs Ruff on all pull requests and branch pushes to ensure code quality.