The bragir CLI is a command-line application built using Click. Its primary purpose is to handle and generate SubRip Subtitle (SRT) files using ChatGPT and Whisper from Openai.
- Translation: Translate the content of SRT files from one language to another using ChatGPT.
- Transcription: Trancribe the content of video and audio files from one language to another using Whisper.
- Batch Processing: Process a single file, multiple files, or an entire directory, providing flexibility and efficiency.
- Easy-to-Use Interface: Utilize a user-friendly command-line interface powered by Click, making translation tasks straightforward.
In order to use the full potential of Bragir, FFmpeg is needed to be installed on the system and you need to obtain an Openai key.
Using brew
brew update && brew install ffmpegUpdate avaiable linux packages
sudo apt updateInstall ffmpeg
sudo apt install ffmpegDownload the .exe from official ffmpeg-website
Extract the contents of the zip file and rename the file to FFmpeg.
Move the folder into the main drive (Usually c:/)
Open command prompt as administrator, and add FFmpeg to your system path
setx /m PATH "C:\ffmpeg\bin;%PATH%"Verifyting the installation In order to see if the installation of FFmpeg is correct, run the following command
ffmpeg --version If a version is displayed, then FFmpeg is installed correctly.
Currently, this tool relise on OpenAIs API. That means that an OpenAI api-key is crucial. See the following resource of how to get an OpenAI api-key
Use pip to install Bragir
pip install bragirCheck if installation is complete
bragir --version
If a version is displayed, then Bragir is installed correctly.
Bragir comes with two commands, transcribe and translate. Transcribe will always generate an file with extension .srt. The translate command has only been tested with SRT-files, however other files would work. However, Bragir is not intended to translate other file types
In order to use bragir, the api key can be loaded into the session or saved in the config.ini file (Default at ~/.bragir/cli/config.ini).
Load Openai key as an enviroment variable into current session
export OPENAI_KEY=<VALUE>
Translate a single file to one language:
bragir translate <FILE_PATH> --language French
Translate one file to multiple languages:
bragir translate <FILE_PATH> --language French --language German
Translate files in a directory to multiple languages:
bragir translate <DIRECTORY_PATH> --language French --language German
Transcribe file:
bragir transcribe <FILE_PATH>
Transcribe files in a directory:
bragir transcribe <DIRECTORY_PATH>
If you want to contribute to this project, please use the following steps:
- Fork the project.
- Create a new branch (git checkout -b feature/awesome-feature).
- Commit your changes (git commit -m 'Add some feature').
- Push to the branch (git push origin feature/awesome-feature).
- Open a pull request.
This projects aims to follow the Conventional Commits guidelines.
When writing commit messages, use one of the following categories to clearly describe the purpose of your commit:
- feat / feature: ✨ Introducing new features
- fix / bugfix: 🐛 Addressing bug fixes
- perf: 🚀 Enhancing performance
- refactor: 🔄 Refactoring code - Not displayed in CHANGELOG
- test / tests: ✅ Adding or updating tests - Not displayed in CHANGELOG
- build / ci: 🛠️ Build system or CI/CD updates - Not displayed in CHANGELOG
- doc / docs: 📚 Documentation changes - Not displayed in CHANGELOG
- style: 🎨 Code style or formatting changes - Not displayed in CHANGELOG
- chore: 🔧 Miscellaneous chores
- other: 🌟 Other significant changes
feat: Add cool new featurefix: Resolve unexpected behavior with translation
This project is licensed under the MIT License.