# 🎙️ Voxcribe
Voxcribe is a Python package for transcribing audio files into text using speech recognition. It splits audio into manageable chunks, processes them in parallel, and combines the results into a single transcription.
---
## ✨ Features
- 🔊 **Supports Multiple Formats**: Works with MP3, WAV, and other audio formats.
- ⚡ **Chunk-based Processing**: Splits large audio files into smaller chunks for efficient processing.
- 🖥️ **Parallel Processing**: Utilizes all available CPU cores for faster transcription.
- 📊 **Optional Progress Bar**: Displays a progress bar during processing, which can be disabled if needed.
---
## 📦 Installation
Install Voxcribe using pip:
```bash
pip install voxcribe
```
### 🛠️ Prerequisites
Ensure the following dependencies are installed:
- [FFmpeg](https://ffmpeg.org/) (required by `pydub` for handling MP3 and other formats).
To install FFmpeg:
- **Linux**: Use your package manager (e.g., `sudo apt install ffmpeg`).
- **MacOS**: Use Homebrew (`brew install ffmpeg`).
- **Windows**: Download and install it from [FFmpeg's official website](https://ffmpeg.org/download.html).
---
## 🚀 Usage
### Example Code
```python
from voxcribe import Voxcribe
# Initialize the transcriber
transcriber = Voxcribe(chunk_duration=30, show_progress=True)
# Transcribe an audio file
result = transcriber.transcribe("audio.mp3")
# Print the transcription
print("Transcription:")
print(result)
```
### 🔧 Parameters
- `chunk_duration` (default: `30`): Duration of each audio chunk in seconds.
- `show_progress` (default: `True`): Whether to display a progress bar during transcription.
---
## 📋 Requirements
- 🐍 Python 3.6 or later
- 📜 Dependencies:
- `speechrecognition`
- `pydub`
- `tqdm`
Install dependencies using pip:
```bash
pip install -r requirements.txt
```
---
## 📜 License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
---
## 💡 Acknowledgments
- 🔧 Built with the help of [SpeechRecognition](https://pypi.org/project/SpeechRecognition/) and [pydub](https://pypi.org/project/pydub/).
- 📊 Progress bar powered by [tqdm](https://pypi.org/project/tqdm/).
---
## 📬 Contact
For issues or suggestions, feel free to:
- Open an issue on the [GitHub repository](https://github.com/VedantBarhate/voxcribe)
- 📧 Email me at `vedant.barhate27@example.com`
Raw data
{
"_id": null,
"home_page": "https://github.com/VedantBarhate/voxcribe",
"name": "voxcribe",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Vedant Barhate",
"author_email": "vedant.barhate27@example.com",
"download_url": "https://files.pythonhosted.org/packages/06/7d/1df598fd4330ed71d4fd94c55bd099e02d3c4086dc028f017e78359d5645/voxcribe-1.0.0.tar.gz",
"platform": null,
"description": "\r\n# \ud83c\udf99\ufe0f Voxcribe\r\n\r\nVoxcribe is a Python package for transcribing audio files into text using speech recognition. It splits audio into manageable chunks, processes them in parallel, and combines the results into a single transcription.\r\n\r\n---\r\n\r\n## \u2728 Features\r\n\r\n- \ud83d\udd0a **Supports Multiple Formats**: Works with MP3, WAV, and other audio formats.\r\n- \u26a1 **Chunk-based Processing**: Splits large audio files into smaller chunks for efficient processing.\r\n- \ud83d\udda5\ufe0f **Parallel Processing**: Utilizes all available CPU cores for faster transcription.\r\n- \ud83d\udcca **Optional Progress Bar**: Displays a progress bar during processing, which can be disabled if needed.\r\n\r\n---\r\n\r\n## \ud83d\udce6 Installation\r\n\r\nInstall Voxcribe using pip:\r\n\r\n```bash\r\npip install voxcribe\r\n```\r\n\r\n### \ud83d\udee0\ufe0f Prerequisites\r\n\r\nEnsure the following dependencies are installed:\r\n- [FFmpeg](https://ffmpeg.org/) (required by `pydub` for handling MP3 and other formats).\r\n\r\nTo install FFmpeg:\r\n- **Linux**: Use your package manager (e.g., `sudo apt install ffmpeg`).\r\n- **MacOS**: Use Homebrew (`brew install ffmpeg`).\r\n- **Windows**: Download and install it from [FFmpeg's official website](https://ffmpeg.org/download.html).\r\n\r\n---\r\n\r\n## \ud83d\ude80 Usage\r\n\r\n### Example Code\r\n\r\n```python\r\nfrom voxcribe import Voxcribe\r\n\r\n# Initialize the transcriber\r\ntranscriber = Voxcribe(chunk_duration=30, show_progress=True)\r\n\r\n# Transcribe an audio file\r\nresult = transcriber.transcribe(\"audio.mp3\")\r\n\r\n# Print the transcription\r\nprint(\"Transcription:\")\r\nprint(result)\r\n```\r\n\r\n### \ud83d\udd27 Parameters\r\n- `chunk_duration` (default: `30`): Duration of each audio chunk in seconds.\r\n- `show_progress` (default: `True`): Whether to display a progress bar during transcription.\r\n\r\n---\r\n\r\n## \ud83d\udccb Requirements\r\n\r\n- \ud83d\udc0d Python 3.6 or later\r\n- \ud83d\udcdc Dependencies:\r\n - `speechrecognition`\r\n - `pydub`\r\n - `tqdm`\r\n\r\nInstall dependencies using pip:\r\n```bash\r\npip install -r requirements.txt\r\n```\r\n\r\n---\r\n\r\n## \ud83d\udcdc License\r\n\r\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\r\n\r\n---\r\n\r\n## \ud83d\udca1 Acknowledgments\r\n\r\n- \ud83d\udd27 Built with the help of [SpeechRecognition](https://pypi.org/project/SpeechRecognition/) and [pydub](https://pypi.org/project/pydub/).\r\n- \ud83d\udcca Progress bar powered by [tqdm](https://pypi.org/project/tqdm/).\r\n\r\n---\r\n\r\n## \ud83d\udcec Contact\r\n\r\nFor issues or suggestions, feel free to:\r\n- Open an issue on the [GitHub repository](https://github.com/VedantBarhate/voxcribe)\r\n- \ud83d\udce7 Email me at `vedant.barhate27@example.com`\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A lightweight audio transcription tool using speech recognition.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/VedantBarhate/voxcribe"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "24ef751e85b0bfbc2edd73fa3198066d5b6584bf6c5acf06d6446d8d23daea0c",
"md5": "7b2a62d80ba4898c1bcdf621a1c72c42",
"sha256": "8cdde3093d04ea0239682a085ad150fabc7c8275c712901d57d815b22af82598"
},
"downloads": -1,
"filename": "voxcribe-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7b2a62d80ba4898c1bcdf621a1c72c42",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4487,
"upload_time": "2025-01-06T18:30:35",
"upload_time_iso_8601": "2025-01-06T18:30:35.033308Z",
"url": "https://files.pythonhosted.org/packages/24/ef/751e85b0bfbc2edd73fa3198066d5b6584bf6c5acf06d6446d8d23daea0c/voxcribe-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "067d1df598fd4330ed71d4fd94c55bd099e02d3c4086dc028f017e78359d5645",
"md5": "693d9d7fc1a1c53fb49d1f959494f52d",
"sha256": "90e07a749baeb7e6533516bb6c6385108d5a0edd671e7c4158b9ef1af4be5979"
},
"downloads": -1,
"filename": "voxcribe-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "693d9d7fc1a1c53fb49d1f959494f52d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4148,
"upload_time": "2025-01-06T18:30:38",
"upload_time_iso_8601": "2025-01-06T18:30:38.490089Z",
"url": "https://files.pythonhosted.org/packages/06/7d/1df598fd4330ed71d4fd94c55bd099e02d3c4086dc028f017e78359d5645/voxcribe-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-06 18:30:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VedantBarhate",
"github_project": "voxcribe",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "speechrecognition",
"specs": [
[
">=",
"3.8.1"
]
]
},
{
"name": "pydub",
"specs": [
[
">=",
"0.25.1"
]
]
},
{
"name": "tqdm",
"specs": [
[
">=",
"4.64.0"
]
]
}
],
"lcname": "voxcribe"
}
JSON
