| Name | whisperkey JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Whisper key |
| upload_time | 2025-03-13 15:06:49 |
| maintainer | None |
| docs_url | None |
| author | Daniel |
| requires_python | <4.0,>=3.12 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 🎙️ WhisperKey
[](https://pypi.org/project/whisperkey/)
[](https://opensource.org/licenses/MIT)
[](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
Raw data
{
"_id": null,
"home_page": null,
"name": "whisperkey",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": null,
"author": "Daniel",
"author_email": "danielratmiroff@pm.me",
"download_url": "https://files.pythonhosted.org/packages/3f/fe/506b05f2cb66a708a23c314564958c3f40691aab9163bcbe4e27d5481436/whisperkey-0.1.1.tar.gz",
"platform": null,
"description": "# \ud83c\udf99\ufe0f WhisperKey\n\n[](https://pypi.org/project/whisperkey/)\n[](https://opensource.org/licenses/MIT)\n[](https://pypi.org/project/whisperkey/)\n\n**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.\n\n## \u2728 Features\n\n- \ud83d\udd11 **Global Hotkey**: Start/stop recording with Alt+G from anywhere on your system\n- \ud83d\udccb **Clipboard Integration**: Automatically copies transcriptions to your clipboard\n- \ud83d\udd12 **Privacy-Focused**: Audio recordings are stored temporarily in your local cache\n\n## \ud83d\ude80 Installation\n\n### Prerequisites\n\n- Python 3.12 or higher\n- OpenAI API key\n\n### Using pip\n\n```bash\npip install whisperkey\n```\n\n### From source\n\n```bash\ngit clone https://github.com/Danielratmiroff/whisper-key.git\ncd whisper-key\npoetry install # or pip install poetry \n```\n\n## \u2699\ufe0f Configuration\n\nBefore using WhisperKey, you need to set up your OpenAI API key:\n\n```bash\nexport OPENAI_API_KEY=\"your-api-key-here\"\n```\n\nFor permanent configuration, add this to your shell profile file (`.bashrc`, `.zshrc`, etc.).\n\n## \ud83c\udfae Usage\n\n1. Start WhisperKey:\n ```bash\n whisperkey\n ```\n\n2. Press **Alt+G** to start recording\n\n3. Press **Alt+G** again to stop recording\n\n4. The transcription will be processed and automatically copied to your clipboard\n\n## \ud83e\udd1d Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request from your forked repository\n\n## \ud83d\udcc4 License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## \ud83d\ude4f Acknowledgements\n\n- [OpenAI Whisper](https://openai.com/research/whisper) for the speech recognition API\n- [PyAudio](https://people.csail.mit.edu/hubert/pyaudio/) for audio recording capabilities\n- [pynput](https://pypi.org/project/pynput/) for keyboard shortcut handling\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Whisper key",
"version": "0.1.1",
"project_urls": {
"documentation": "https://github.com/Danielratmiroff/whisper-key#readme",
"homepage": "https://github.com/Danielratmiroff/whisper-key",
"issues": "https://github.com/Danielratmiroff/whisper-key/issues",
"repository": "https://github.com/Danielratmiroff/whisper-key"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "055060f7768b856f7cbcd102367e92cfab24445438d3bbd2f2d328ac3d2fbb93",
"md5": "01af8d4231147a8da1d3bdca2869241c",
"sha256": "1e1bd5e1425db393d064f6621509e8a6c15701f1dbe25410a48ef49fd9b4d0b6"
},
"downloads": -1,
"filename": "whisperkey-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "01af8d4231147a8da1d3bdca2869241c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 7649,
"upload_time": "2025-03-13T15:06:47",
"upload_time_iso_8601": "2025-03-13T15:06:47.948615Z",
"url": "https://files.pythonhosted.org/packages/05/50/60f7768b856f7cbcd102367e92cfab24445438d3bbd2f2d328ac3d2fbb93/whisperkey-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3ffe506b05f2cb66a708a23c314564958c3f40691aab9163bcbe4e27d5481436",
"md5": "1e576c4591cf1b05fa7ba2f52f15c1f2",
"sha256": "1d74cf55d2982fd450f535709e5f02086c02f760e4c20fcd41fcde8bd693476d"
},
"downloads": -1,
"filename": "whisperkey-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "1e576c4591cf1b05fa7ba2f52f15c1f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 6649,
"upload_time": "2025-03-13T15:06:49",
"upload_time_iso_8601": "2025-03-13T15:06:49.328630Z",
"url": "https://files.pythonhosted.org/packages/3f/fe/506b05f2cb66a708a23c314564958c3f40691aab9163bcbe4e27d5481436/whisperkey-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-13 15:06:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Danielratmiroff",
"github_project": "whisper-key#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "whisperkey"
}
