semvec/pypi-packages huggingface dataset:
whisperkey 0.2.0
Whisper key
License: MIT
Requires Python: <4.0,>=3.12

# 🎙️ WhisperKey

[![PyPI version](https://img.shields.io/pypi/v/whisperkey.svg)](https://pypi.org/project/whisperkey/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python Version](https://img.shields.io/pypi/pyversions/whisperkey)](https://pypi.org/project/whisperkey/)

**WhisperKey** is a lightweight application that lets you transcribe speech to text. Simply press a keyboard shortcut, speak, and get your transcription copied directly to your clipboard.

## ✨ Features

- 🔑 **Global Hotkey**: Start/stop recording with Alt+G from anywhere on your system
- 📋 **Clipboard Integration**: Automatically copies transcriptions to your clipboard
- 🔒 **Privacy-Focused**: Audio recordings are stored temporarily in your local cache

## 🚀 Installation

### Prerequisites

- Python 3.12 or higher
- OpenAI API key

### Using pip

```bash
pip install whisperkey
```

### From source

```bash
git clone https://github.com/Danielratmiroff/whisper-key.git
cd whisper-key
poetry install # or pip install poetry 
```

## ⚙️ Configuration

Before using WhisperKey, you need to set up your OpenAI API key:

```bash
export OPENAI_API_KEY="your-api-key-here"
```

For permanent configuration, add this to your shell profile file (`.bashrc`, `.zshrc`, etc.).

## 🎮 Usage

1. Start WhisperKey:
   ```bash
   whisperkey
   ```

2. Press **Alt+G** to start recording

3. Press **Alt+G** again to stop recording

4. The transcription will be processed and automatically copied to your clipboard

## 🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request from your forked repository

## 📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

## 🙏 Acknowledgements

- [OpenAI Whisper](https://openai.com/research/whisper) for the speech recognition API
- [PyAudio](https://people.csail.mit.edu/hubert/pyaudio/) for audio recording capabilities
- [pynput](https://pypi.org/project/pynput/) for keyboard shortcut handling