Metadata-Version: 2.4
Name: realtime_subtitle
Version: 0.0.10
Summary: realtime subtitle
Project-URL: Homepage, https://github.com/caoqiming/realtime-subtitle
Project-URL: Issues, https://github.com/caoqiming/realtime-subtitle/issues
Author-email: qiming <glimmerddl@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: argostranslate>=1.9.6
Requires-Dist: huggingface-hub==0.34.4
Requires-Dist: mlx-whisper==0.4.2
Requires-Dist: numpy>=2.0.2
Requires-Dist: pyaudio>=0.2.14
Requires-Dist: pyqt6==6.9.0
Requires-Dist: scikit-learn>=1.6.1
Requires-Dist: speechbrain==1.0.3
Requires-Dist: torch>=2.7.0
Requires-Dist: translate>=3.6.1
Description-Content-Type: text/markdown

# realtime subtitle

[中文](./README-zh.md)

This is an offline realtime subtitle program for M-series mac.

## install

require python >=3.9

```bash
# install dependencies
# if you don't have brew, install it from https://brew.sh/
brew install portaudio

# install realtime-subtitle via pip
pip install realtime-subtitle
```

## usage

```bash
# to run with a ui
realtime-subtitle ui

# to parse a wav file
realtime-subtitle parse -f {your_wav_file_path}
```

you can find more whisper models [here](https://huggingface.co/collections/mlx-community/whisper-663256f9964fbb1177db93dc)

if you want to reset your config, you can just remove it.

```bash
rm ~/.config/glimmer/realtime-subtitle.config
```

if you want to clean your local model. Note that once delete, you will have to redownload them if you want to use realtime subtitle.
But sometimes this may help if you stuck in downloading or loading(this may happen if your mlx version has changed), you can delete them and redownload.

```bash
rm -rf /Users/glimmer/.cache/huggingface
```
