Metadata-Version: 2.4
Name: realtimestt-multiclient
Version: 0.1.0
Summary: Realtime speech-to-text client and server with multi-client support
Author-email: Hendric Voß <hvoss@techfak.uni-bielefeld.de>, Vincent Emmerling <vemmerling@techfak.uni-bielefeld.de>
Project-URL: Homepage, https://scs.techfak.uni-bielefeld.de/
Project-URL: Repository, https://gitlab.ub.uni-bielefeld.de/scs/enrico/modules/realtimestt_multiclient
Keywords: speech,stt,whisper,realtime,audio,webrtcvad
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: PyAudio==0.2.14
Requires-Dist: faster-whisper==1.1.1
Requires-Dist: pvporcupine==1.9.5
Requires-Dist: webrtcvad-wheels==2.0.14
Requires-Dist: halo==0.0.31
Requires-Dist: torch
Requires-Dist: torchaudio
Requires-Dist: scipy==1.15.2
Requires-Dist: openwakeword>=0.4.0
Requires-Dist: websockets==15.0.1
Requires-Dist: websocket-client==1.8.0
Requires-Dist: soundfile==0.13.1

# RealtimeSTT Multiclient

An extended RealtimeSST server that supports multiple clients connecting simultaneously, and API key authentication. Developed for the [SCS](https://scs.techfak.uni-bielefeld.de/) group. Built using FastAPI and Docker for easy deployment.
Adatped from the original [RealtimeSTT server](https://github.com/KoljaB/RealtimeSTT) project.

---

## Installation

**Pull the repository**

```bash
git clone git@gitlab.ub.uni-bielefeld.de:scs/enrico/modules/realtimestt_multiclient.git
cd realtimestt_multiclient
```

Create a .env file containing your desired api key:

```.dotenv
API_KEY_REALTIMESTT=your_api_key
```

### Using Docker

1. **Build the Docker image**

```bash
docker build -t realtimestt_multiclient .
```

2. **Run the Docker container**

```bash
docker run -d --gpus all --env-file .env --name realtimestt_multiclient -p 8011:8011 -p 8012:8012 realtimestt_multiclient
```

---

### Running Without Docker

1. **Install dependencies**

```bash
pip install -r requirements.txt
```

2. **Start the FastAPI app**

```bash
python RealtimeSTT_server/stt_server.py --model large-v2 --language de --open_lan --debug
```
