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.2.0.tar.gz (5.1 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.2.0-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: whisper-clipboard-0.2.0.tar.gz
  • Upload date:
  • Size: 5.1 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.2.0.tar.gz
Algorithm Hash digest
SHA256 92cfa53ac871e2a7e86351510da3d8f02895ff71dc937f3c483ad7f0dfe871a3
MD5 11afd1754108d8e6fc5f8f9332b3344e
BLAKE2b-256 2109704022054cfb4ad19b6114f613dd96c42800a8e1f5377d8f30f633232c0d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for whisper_clipboard-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b7f855a733631b80526fde67cb482c2af609a77a72e613288d7be21ea950f9d0
MD5 34482bee06db912ee3044f2d970b8318
BLAKE2b-256 313290af494dcb57a8cd73c9b3e4cda31da76d088311ccbd0c1e8aca1a6d6559

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