Skip to content

Latest commit

 

History

History
86 lines (64 loc) · 2.16 KB

README.md

File metadata and controls

86 lines (64 loc) · 2.16 KB

Groq Whisperer: Voice-to-Text Transcription Tool

Groq Whisperer is a Python-based application that allows users to record audio and transcribe it to text using Groq's Whisper implementation. The transcribed text is automatically copied to the clipboard for easy pasting into other applications.

Features

  • Record audio by holding down the PAUSE key
  • Transcribe recorded audio to text using Groq's API
  • Automatically copy transcription to clipboard
  • Continuous operation for multiple recordings

Prerequisites

  • Python 3.7 or higher
  • A Groq API key (set as an environment variable)

Installation

  1. Clone the repository:

    git clone https://github.com/KennyVaneetvelde/groq_whisperer
    cd whisperer
    
  2. Create a virtual environment:

    python -m venv venv
    
  3. Activate the virtual environment:

    • On Windows:
      venv\Scripts\activate
      
    • On macOS and Linux:
      source venv/bin/activate
      
  4. Install the required packages:

    pip install -r requirements.txt
    
  5. Set up your Groq API key as an environment variable:

    • On Windows:
      setx GROQ_API_KEY "your-api-key-here"
      
    • On macOS and Linux:
      export GROQ_API_KEY="your-api-key-here"
      

Usage

  1. Run the script:

    python main.py
    
  2. Press and hold the PAUSE key to start recording.

  3. Release the PAUSE key to stop recording and start transcription.

  4. The transcribed text will be automatically copied to your clipboard.

  5. Repeat steps 2-4 for additional recordings.

Dependencies

The project relies on the following main libraries:

  • pyaudio: For audio recording
  • keyboard: For detecting key presses
  • pyautogui and pyperclip: For clipboard operations
  • groq: For interacting with the Groq API

For a complete list of dependencies, see the requirements.txt file.

Notes

  • Make sure your microphone is properly configured and working before running the script.
  • The transcription quality may vary depending on the audio quality and background noise.
  • Ensure you have a stable internet connection for the transcription process.

License

MIT License