Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antoniosbarotsis/telegram-transcriber
A Telegram bot for transcribing voice messages
https://github.com/antoniosbarotsis/telegram-transcriber
telegram transcribe voice whisper
Last synced: 9 days ago
JSON representation
A Telegram bot for transcribing voice messages
- Host: GitHub
- URL: https://github.com/antoniosbarotsis/telegram-transcriber
- Owner: AntoniosBarotsis
- License: gpl-3.0
- Created: 2024-04-03T16:26:57.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-05-08T23:19:34.000Z (6 months ago)
- Last Synced: 2024-10-16T05:11:23.054Z (23 days ago)
- Topics: telegram, transcribe, voice, whisper
- Language: Rust
- Homepage:
- Size: 394 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Telegram Transcriber Bot
A simple Telegram bot that replies to voice messages with their transcription.
The project is split into a [Whisper](https://github.com/SYSTRAN/faster-whisper) server (`./python`) and
the telegram bot (`./rust`).
## The Whisper Server
### Dependencies
- Python 3.10
- CUDA version 12
- WSL (if on Windows)
### Configuration
1. Create a Python virtual environment:
```
python -m venv name_of_your_venv
```
2. Activate the virtual environment
```
source name_of_your_venv/bin/activate
```
2. Install the requirements:
```
pip install -r requirements.txt
```
### Testing if Whisper can run
You can run
```
python test_transcription.py
```
To test whether everything has been installed correctly. The output should be plain text.
### Running
The API used to receive and respond to requests is FastAPI and the server can be run using Uvicorn:
```
uvicorn main:app
```
By default, the port it will receive requests on is `8000`. You will also need to forward this port and set a static IP.
An alternative would be to configure [ngrok](https://dashboard.ngrok.com/get-started/setup/windows).
If you want to test changes to the code whilst running the bot, add `--reload` at the end of the command.
## The Telegram Bot
### Dependencies
- [ffmpeg](https://ffmpeg.org/download.html)
- [openssl](https://docs.rs/openssl/latest/openssl/#automatic)
### Configuration
Create a `./rust/.env` file and fill in the following parameters:
- `TELOXIDE_TOKEN`: [The Telegram bot token](https://core.telegram.org/bots#how-do-i-create-a-bot)
- `CHAT_IDS`: A comma delimited list of whitelisted chat ids.
[Here's a thread on how to get those](https://stackoverflow.com/a/69302407/12756474)
- `WHISPER_URL`: The URL of the Whisper server
- `RUST_LOG` (optional): Use this to configure logging. I have it set to `RUST_LOG=info,telegram_transcriber=debug`
but `RUST_LOG=info` is probably enough for you.
### Running
This is just another Rust project so you can just `cargo run`. I wanted to run this on my Raspberry
Pi and just to save you a few headaches, if you only connect to your Pi via SSH, try running it with
`nohup cargo r -r &`, this will run it in the background even after you disconnect from the SSH
session and all the logs will be dumped in `./rust/nohup.out`.
### Cross Compiling
We are running the bot on a Raspberry Pi which takes sometime to compile (especially on release).
OpenSSL always causes some issues with cross compilation but thankfully,
[`cargo cross`](https://github.com/cross-rs/cross) helps with that. We opted to solve the issue by
optionally statically compiling OpenSSL into the binary which you can do with the following:
```sh
$ cross build --target aarch64-unknown-linux-gnu -r -F openssl-vendored
```
This is admitedly not very fast but it is fast*er*. If you really want you can check out
[this](https://github.com/cross-rs/cross/wiki/Recipes#pre-build) to link it dynamically instead,
just know you might need to fiddle with your apt sources or build some libs from source.