# AudioTools
Object-oriented handling of audio signals, with fast augmentation routines, batching, padding, and more.
## Installation
```
pip install git+https://github.com/descriptinc/audiotools
```
OR
```bash
git clone https://github.com/descriptinc/audiotools
cd audiotools
pip install .
```
## Documentation
For documentation, see [the docs](https://descriptinc.github.io/audiotools/).
### Deploying documentation
To build the documentation, do:
```bash
cd docs/
make html
open _build/html/index.html
```
Once you're satisfied with your docs, push them to the gh-pages branch via
```bash
cd docs
bash publish_docs.sh
```
## Quickstart
```python
import audiotools
from audiotools import AudioSignal
signal = AudioSignal("tests/audio/spk/f10_script4_produced.wav", offset=5, duration=5)
signal.play() # Play back the signal in your terminal using ffplay
signal.low_pass(8000) # Low-pass the signal
signal.play() # Play back the low-passed version of the signal
```
For more, see the [documentation](##Documentation).
### Install hooks
First install the pre-commit util:
https://pre-commit.com/#install
pip install pre-commit # with pip
brew install pre-commit # on Mac
Then install the git hooks
pre-commit install
# check .pre-commit-config.yaml for details of hooks
Upon `git commit`, the pre-commit hooks will be run automatically on the stage files (i.e. added by `git add`)
**N.B. By default, pre-commit checks only run on staged files**
If you need to run it on all files:
pre-commit run --all-files
Raw data
{
"_id": null,
"home_page": "",
"name": "descript-audiotools",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Prem Seetharaman, Lucas Gestin",
"author_email": "prem@descript.com",
"download_url": "https://files.pythonhosted.org/packages/8c/e7/8c4d16e8ff5785103877a7782a41585b23ea3a457681cca20fe1d79f0810/descript-audiotools-0.7.2.tar.gz",
"platform": null,
"description": "# AudioTools\n\nObject-oriented handling of audio signals, with fast augmentation routines, batching, padding, and more.\n\n## Installation\n```\npip install git+https://github.com/descriptinc/audiotools\n```\nOR\n```bash\ngit clone https://github.com/descriptinc/audiotools\ncd audiotools\npip install .\n```\n\n## Documentation\n\nFor documentation, see [the docs](https://descriptinc.github.io/audiotools/).\n\n### Deploying documentation\n\nTo build the documentation, do:\n\n```bash\ncd docs/\nmake html\nopen _build/html/index.html\n```\n\nOnce you're satisfied with your docs, push them to the gh-pages branch via\n\n```bash\ncd docs\nbash publish_docs.sh\n```\n\n## Quickstart\n\n```python\nimport audiotools\nfrom audiotools import AudioSignal\n\nsignal = AudioSignal(\"tests/audio/spk/f10_script4_produced.wav\", offset=5, duration=5)\nsignal.play() # Play back the signal in your terminal using ffplay\n\nsignal.low_pass(8000) # Low-pass the signal\nsignal.play() # Play back the low-passed version of the signal\n```\n\nFor more, see the [documentation](##Documentation).\n\n### Install hooks\n\nFirst install the pre-commit util:\n\nhttps://pre-commit.com/#install\n\n pip install pre-commit # with pip\n brew install pre-commit # on Mac\n\nThen install the git hooks\n\n pre-commit install\n # check .pre-commit-config.yaml for details of hooks\n\nUpon `git commit`, the pre-commit hooks will be run automatically on the stage files (i.e. added by `git add`)\n\n**N.B. By default, pre-commit checks only run on staged files**\n\nIf you need to run it on all files:\n\n pre-commit run --all-files\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Utilities for handling audio.",
"version": "0.7.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "68b872a58cb3b241d869811be4f9328a37f1563dc9c48af8c0467cb681f9ed46",
"md5": "6586ec50a401fd7844f9b2c4bf989c37",
"sha256": "bb7a4e837f92395e43894d99a89406485325b88c6f158caf59e18876cf5b06ea"
},
"downloads": -1,
"filename": "descript_audiotools-0.7.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "6586ec50a401fd7844f9b2c4bf989c37",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 106704,
"upload_time": "2023-07-19T17:41:03",
"upload_time_iso_8601": "2023-07-19T17:41:03.108595Z",
"url": "https://files.pythonhosted.org/packages/68/b8/72a58cb3b241d869811be4f9328a37f1563dc9c48af8c0467cb681f9ed46/descript_audiotools-0.7.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8ce78c4d16e8ff5785103877a7782a41585b23ea3a457681cca20fe1d79f0810",
"md5": "a893606be6c7f235b1db968132bb5fb7",
"sha256": "2cdd363025c771b8acc53d5ef9ec77e34f92e182272c4be7fd0118a99b6a5e2a"
},
"downloads": -1,
"filename": "descript-audiotools-0.7.2.tar.gz",
"has_sig": false,
"md5_digest": "a893606be6c7f235b1db968132bb5fb7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 99357,
"upload_time": "2023-07-19T17:41:05",
"upload_time_iso_8601": "2023-07-19T17:41:05.139348Z",
"url": "https://files.pythonhosted.org/packages/8c/e7/8c4d16e8ff5785103877a7782a41585b23ea3a457681cca20fe1d79f0810/descript-audiotools-0.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-19 17:41:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "descript-audiotools"
}
JSON