TeleWhisper - Public Release

Public version of the TeleWhisper project. Consider joining the Telegram support group

This Telegram bot is able to, in private chat with it, transcribe audios, videos, music, etc. to text, and send it back to you.

Structure may be a bit messy, as it was not intended to be public, but it works as intended. Feel free to use it, modify it, and do whatever you want with it as long as you follow the license.

Table of contents

• How it works

• How to use

  • Using the bot
  • Running your own bot
    • Requirements
    • Installation
    • Running it locally
    • Using a VPS

• Learn more

• License

• Contributing

• Contact

How it works

This bot uses OpenAIs whisper model in order to get the trasncription from any multimedia file. It also uses the Telegram Bot API to interact with the user. In order to connect to the API, it uses the python-telegram-bot library.

You can head out to the Wiki to learn more about the files and how they work.

How to use

Using the bot

---

Get in Telegram and search for @TeleWhisperBot, or click here. Click on START button to start using it. Then send any audio, video, music, etc. to it, and it will send you back the transcription.

Running your own bot

---

Requirements

• Python 3.6 or higher

• FFmpeg installed and added to PATH:

  • Windows: Download
  • Linux: sudo apt install ffmpeg

• A Telegram bot token. You can get one by talking to @BotFather in Telegram.

• An OpenAI API key. You can get one by signing up here.

• (optional) A payment token. You can get it also by talking to @BotFather in Telegram. If you're not planning on using the /tip command, you should remove it from the code. Head to the Wiki to learn how to do it.

---

Installation

1. Clone the repository:

git clone https://github.com/FosanzDev/TeleWhisperPublic.git

2. Install the requirements:

pip install -r requirements.txt

3. Install ffmpeg:

• Windows: Download
• Linux: sudo apt install ffmpeg

4. Insert the API keys in the keyHolder.py file:

telegramApiKey = '...'
openaiApiKey = '...'
paymentProcessorApiKey = '...'

---

Running it locally

You can run it locally by running the telegramListener.py file:

python3 telegramListener.py

This will start the bot, and you will be able to use it in Telegram. If you want to stop it, just press CTRL + C in the terminal.

You can also set up a Raspberry Pi to run it 24/7. You can follow the steps shown in Using a VPS to do so.

---

Using a VPS

For this bot, a VPS is recommended, as it will be running 24/7. You can use any VPS provider you want, but I recommend IONOS 1&1 (This is the spanish version of the page since it's cheaper than the US one). Personally a VPS with 1 vCore and 1GB of RAM is way more than enough, but you can use more if you want.

Make sure it runs python 3.6 or higher, and that you have installed ffmpeg. Recommended OS is Ubuntu 20.04. Tutorial will be based on this OS and version.

1. Connect to the VPS via SSH. I recommend using Termius since it's free and multiplatform.

2. Clone the repo, install the requirements and ffmpeg as shown in Installation.

3. Insert the API keys in the keyHolder.py file as shown in Installation.

4. Run the bot:

python3 telegramListener.py & disown
# Using disown will make the process run in the background, so you can close the SSH session without stopping the bot.

5. Make it a service (optional):

First, create an script that will run the bot:

nano runBot.sh

Then, insert the following code:

#!/bin/bash
cd /path/to/the/repo
git pull --force # This will make sure the bot is always up to date
python3 telegramListener.py

Save the file and exit the editor.

Now, create a service file:

sudo nano /etc/systemd/system/telewhisper.service

And insert the following code:

[Unit]
Description=TeleWhisper Bot

[Service]
ExecStart=/path/to/the/script/runBot.sh

[Install]
WantedBy=multi-user.target

Save the systemctl config:

sudo systemctl reload

And enable the service:

sudo systemctl enable telewhisper.service

This will make the bot run as a service, so it will start automatically when the VPS boots up. You can also start/stop/restart the bot with the following commands:

sudo systemctl start telewhisper
sudo systemctl stop telewhisper
sudo systemctl restart telewhisper

---

Learn more

• You can head out to the Wiki to learn more about the files and how they work.

• You can also check out the Telegram Bot API and the python-telegram-bot library to learn more about how the bot works.

• You can also check out the OpenAI API to learn more about how the transcription works.

• You can also check out the OpenAI whisper model to learn deeper about how the transcription works.

---

License

Distributed under the GNU General Public License v3.0. See LICENSE for more information.

---

Contributing

You can contribute to this project by forking it and making a pull request. You can also contact me via Telegram @Fosanz.

You can contribute economically by donating to the following addresses:

• PayPal: paypal.me/fosanzdev
• BuyMeACoffee: Fosanzdev

---

Contact

Any questions, suggestions or issues, you can contact me via Telegram @Fosanz or by sending an email to fosanzdev@gmail.com