| Name | speechcapture JSON |
| Version |
0.5.0
JSON |
| download |
| home_page | None |
| Summary | An easy to use library for recording and saving speech audio |
| upload_time | 2025-08-11 15:42:20 |
| maintainer | None |
| docs_url | None |
| author | Bilal Darwish |
| requires_python | >=3.8 |
| license | MIT License
Copyright (c) 2025 Bilal Darwish
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
speech
audio
record
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align='center'>
<img src=logo.png width=150>
</div>
<h1 align='center'>SpeechCapture</h1>
An easy to use library for recording and saving speech audio
<details open>
<summary>Table of Contents</summary>
<ol>
<li><a href="#about-the-project">About The Project</a></li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>
## About the Project
SpeechCapture is a Python library made to simplify the complex process of recording and saving your voice automatically from Python code.
### Features
<ul>
<li>Automatic stop on silence</li>
<li>Customizable silence threshold</li>
<li>Dynamically adjust threshold based on surrounding noise</li>
<li>Pausing and resuming recording</li>
<li>Saving audio as .WAV at any time</li>
<li>Recording in background threads</li>
<li>Simultaneous recordings</li>
<li>Stopping at any time</li>
</ul>
## Getting Started
### Prerequisites
To use SpeechCapture, you will need the following installed:
- Python 3.8 or higher
### Installation
To install, simply run in your terminal:
```bash
$ pip install speechcapture
```
Once you have installed the package, do not forget to import:
```py
import speechcapture
```
You can now start using SpeechCapture (example usage below)
<hr>
#### **PyAudio**
If installation of PyAudio, a required dependancy, fails, try running the following commands: <br>
**MacOS**
```bash
$ brew install portaudio
$ pip install pyaudio
```
**Ubuntu/Linux**
```bash
$ sudo apt install portaudio19-dev
$ pip install pyaudio
```
## Usage
```py
import speechcapture as sc
file_path = 'output.wav'
r = sc.Recorder(file_path)
r.adjust_for_ambient_noise()
r.max_seconds_of_silence = 3
r.record()
```
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Bilal Darwish - <a href='mailto:darwish.b.bilal@gmail.com'>darwish.b.bilal@gmail.com</a> <br>
Source Code and Issues: https://github.com/bdarwish/speechcapture/
## Acknowledgments
Dependencies:
- [PyAudio](https://pypi.org/project/PyAudio/)
- [NumPy](https://pypi.org/project/numpy/)
Raw data
{
"_id": null,
"home_page": null,
"name": "speechcapture",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "speech, audio, record",
"author": "Bilal Darwish",
"author_email": "darwish.b.bilal@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ba/5b/db9bd756b6c4885bb07c802a667cb369abb6cbb977cc1968539022f332cc/speechcapture-0.5.0.tar.gz",
"platform": null,
"description": "<div align='center'>\n\t<img src=logo.png width=150>\n</div>\n\n<h1 align='center'>SpeechCapture</h1>\n\nAn easy to use library for recording and saving speech audio\n\n<details open>\n <summary>Table of Contents</summary>\n <ol>\n <li><a href=\"#about-the-project\">About The Project</a></li>\n <li>\n <a href=\"#getting-started\">Getting Started</a>\n <ul>\n <li><a href=\"#prerequisites\">Prerequisites</a></li>\n <li><a href=\"#installation\">Installation</a></li>\n </ul>\n </li>\n <li><a href=\"#usage\">Usage</a></li>\n <li><a href=\"#license\">License</a></li>\n <li><a href=\"#contact\">Contact</a></li>\n <li><a href=\"#acknowledgments\">Acknowledgments</a></li>\n </ol>\n</details>\n\n## About the Project\nSpeechCapture is a Python library made to simplify the complex process of recording and saving your voice automatically from Python code.\n\n### Features\n<ul>\n\t<li>Automatic stop on silence</li>\n\t<li>Customizable silence threshold</li>\n\t<li>Dynamically adjust threshold based on surrounding noise</li>\n\t<li>Pausing and resuming recording</li>\n\t<li>Saving audio as .WAV at any time</li>\n\t<li>Recording in background threads</li>\n\t<li>Simultaneous recordings</li>\n\t<li>Stopping at any time</li>\n</ul>\n\n## Getting Started\n### Prerequisites\nTo use SpeechCapture, you will need the following installed:\n- Python 3.8 or higher\n\n### Installation\nTo install, simply run in your terminal:\n```bash\n$ pip install speechcapture\n```\nOnce you have installed the package, do not forget to import:\n```py\nimport speechcapture\n```\nYou can now start using SpeechCapture (example usage below)\n\n<hr>\n\n#### **PyAudio**\nIf installation of PyAudio, a required dependancy, fails, try running the following commands: <br>\n\n**MacOS**\n```bash\n$ brew install portaudio\n$ pip install pyaudio\n```\n\n**Ubuntu/Linux**\n```bash\n$ sudo apt install portaudio19-dev\n$ pip install pyaudio\n```\n\n ## Usage\n ```py\nimport speechcapture as sc\n\nfile_path = 'output.wav'\n\nr = sc.Recorder(file_path)\n\nr.adjust_for_ambient_noise()\n\nr.max_seconds_of_silence = 3\n\nr.record()\n ```\n\n## License\nDistributed under the MIT License. See `LICENSE` for more information.\n\n## Contact\nBilal Darwish - <a href='mailto:darwish.b.bilal@gmail.com'>darwish.b.bilal@gmail.com</a> <br>\n\nSource Code and Issues: https://github.com/bdarwish/speechcapture/\n\n## Acknowledgments\nDependencies:\n- [PyAudio](https://pypi.org/project/PyAudio/)\n- [NumPy](https://pypi.org/project/numpy/)",
"bugtrack_url": null,
"license": "MIT License\n\nCopyright (c) 2025 Bilal Darwish\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.",
"summary": "An easy to use library for recording and saving speech audio",
"version": "0.5.0",
"project_urls": null,
"split_keywords": [
"speech",
" audio",
" record"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b873f38c22240cd2541900445b1e4b68cd759da9515ae8912135ec79289fd4e8",
"md5": "64ff5efe07a7461894b5aec03714d9e6",
"sha256": "88aa52e0cf54be96be913bc58185b3e1d0516f12f509927c2f7aca578a9e8ca5"
},
"downloads": -1,
"filename": "speechcapture-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "64ff5efe07a7461894b5aec03714d9e6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7165,
"upload_time": "2025-08-11T15:42:19",
"upload_time_iso_8601": "2025-08-11T15:42:19.503838Z",
"url": "https://files.pythonhosted.org/packages/b8/73/f38c22240cd2541900445b1e4b68cd759da9515ae8912135ec79289fd4e8/speechcapture-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ba5bdb9bd756b6c4885bb07c802a667cb369abb6cbb977cc1968539022f332cc",
"md5": "d65429f59864e5f3e5cf377dc2fc5ac0",
"sha256": "a4e23a2479d74ec3b49b79729676e03c0d29ca1727259399ea11ff815406ee75"
},
"downloads": -1,
"filename": "speechcapture-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "d65429f59864e5f3e5cf377dc2fc5ac0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5763,
"upload_time": "2025-08-11T15:42:20",
"upload_time_iso_8601": "2025-08-11T15:42:20.720586Z",
"url": "https://files.pythonhosted.org/packages/ba/5b/db9bd756b6c4885bb07c802a667cb369abb6cbb977cc1968539022f332cc/speechcapture-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-11 15:42:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "speechcapture"
}
