Skip to main content

A basic TUI for transcribing audio to your clipboard using OpenAI's whisper models.

Project description

Whisper Transcribe

Welcome to the Whisper Transcribe repository. This is a simple Python command line application that allows you to record audio and transcribe it using one of the Whisper ASR models by OpenAI. It uses a terminal user interface, making it easy to use.

Prerequisites

  • Python 3.10 or higher (probably works with lower versions, but not tested)
  • ffmpeg

Installation from PyPI

pip install whisper-clipboard

And then run transcribe and start transcribing. Please make sure you have ffmpeg installed properly on your system (this may vary between different operating systems).

Installation using the repo

For NixOS Users:

# Step 1: Clone the repository.
git clone https://github.com/data-stepper/whisper-clipboard

# Step 2: cd into the cloned repository.
cd whisper-clipboard

# Step 3: Run Nix-shell to set up the environment and install all necessary packages.
nix-shell

# Step 4: Run the Whisper Transcribe program.
python transcribe.py

For Non-NixOS Users:

# Step 1: Clone the repository.
git clone https://github.com/data-stepper/whisper-clipboard

# Step 2: cd into the cloned repository.
cd whisper-clipboard

# Step 3: (Optional) Create a virtual environment and activate it.
python -m venv venv
source venv/bin/activate
# On Windows, activate the virtual environment with 'venv\Scripts\activate'

# Step 4: Install the required packages.
pip install -r requirements.txt

# Step 5: Run the Whisper Transcribe program.
python transcribe.py

Usage

Start the program using

python transcribe.py

After starting the program, you will see a prompt ('>').

  • Press 'Space' to start recording. While recording, the terminal will display "Recording..."
  • Press 'Space' again to stop recording. The audio will be saved, and the transcription will be displayed in the terminal and copied to the clipboard.
  • Press 'Q' to quit the application.

Troubleshooting

Ensure that you have the required version of Python and FFMPEG installed. If you encounter any issues, feel free to create an issue on this repository.

Happy transcribing!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

whisper-clipboard-0.1.1.tar.gz (3.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

whisper_clipboard-0.1.1-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file whisper-clipboard-0.1.1.tar.gz.

File metadata

  • Download URL: whisper-clipboard-0.1.1.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for whisper-clipboard-0.1.1.tar.gz
Algorithm Hash digest
SHA256 e31204ee8ade7a51842117f45277f1ba3dd13c658f0d84a027b026fe90c540b7
MD5 09f2eb0afdd6abdfd0f25fdc7c2c8a7a
BLAKE2b-256 74095299f10238df5a1f656174e7f389a2ef578b61b741f592e0634736b4908e

See more details on using hashes here.

File details

Details for the file whisper_clipboard-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for whisper_clipboard-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1f9f1036ee02e7c1384013b0092599af221f257157e3b7e0817e26b44c047e45
MD5 6b639a87bfb70135457c9809c6509eb1
BLAKE2b-256 3e27c8ce2784f2f0ad8689c99f7ca54052031f7f5a09d54d9f54f60c797ee3eb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page