| Name | aus-python JSON |
| Version |
0.0.31
JSON |
| download |
| home_page | None |
| Summary | A package with functionality for offline audio processing |
| upload_time | 2024-10-20 18:08:00 |
| maintainer | None |
| docs_url | None |
| author | Jeff Martin |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# aus
## Introduction
This is a Python library for working with audio. It comes in two flavors - a regular Python version called `pyaus`, contained in the `pyaus` directory, and a Cython version called `caus`, contained in the `caus` directory.
## Building and installation
1. If you are running Windows, you can simply run the command `pip install aus-python` to install a prepackaged version from PyPi.
2. If you are not running Windows, or if you want to build and install the package manually, follow these instructions:
1. Before building this package, first decide whether you wish to use the Python version or the Cython version. Copy all of the .py files from `pyaus` or `caus` to the `aus` directory.
2. You will need to have a Python virtual environment with `build` installed in it. Alternatively, you can simply install `build` in your local Python installation. You may also need to install the packages `Cython`, `numpy`, and `setuptools` to build the package.
3. Run the command `python -m build`. The package will be located in the `dist` directory, in both `.whl` and `.tar.gz` format.
4. To install the package in your local Python installation, simply navigate to the `dist` directory and run the command `pip install filename.whl` (replace `filename` with the actual name of the file in the `dist` directory).
5. You are now ready to import `aus` into your Python code. Note that the package name is `aus-python`, because PyPi would not let me use the name `aus`. However, when importing into your Python code, you use the line `import aus.audiofile` or `import aus.operations` etc.
## Documentation
Documentation is available at https://aus.readthedocs.io/en/latest/.
## Dependencies
You will need the following Python libraries: `matplotlib`, `numpy`, `pedalboard`, `regex`, `scipy`. You will also need `Cython` if you want to build the Cython version.
## Modules
The package is divided into 8 modules:
### `aus.analysis`
Tools for spectral analysis and analysis of audio waveforms. Many of these tools are based on formulas from Florian Eyben's "Real-Time Speech and Music Classification," published by Springer in 2016. Among other things, this module computes spectral centroid, entropy, slope, and flatness.
### `aus.audiofile`
This module is for reading and writing audio files, using either the `pedalboard` library or using (slower) code provided here.
### `aus.granulator`
Funtionality for grain extraction
### `aus.operations`
This module has various operations that can be performed on audio, such as spectral frame swapping, equal energy forcing, dc bias removal, and beat envelope generation.
### `aus.plot`
Plotting functionality for audio and spectrum
### `aus.sampler`
Tools for extracting samples from audio
### `aus.spectrum`
Tools for spectral analysis
### `aus.synthesis`
Tools for generating simple waveforms
Raw data
{
"_id": null,
"home_page": null,
"name": "aus-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Jeff Martin",
"author_email": "Jeffrey Martin <jmartin@jeffreymartincomposer.com>",
"download_url": "https://files.pythonhosted.org/packages/51/02/d1a633b40dc71f1f7ada9e7a99f8cb107810699d5b2c17566795a60fde65/aus_python-0.0.31.tar.gz",
"platform": null,
"description": "# aus\r\n\r\n## Introduction\r\nThis is a Python library for working with audio. It comes in two flavors - a regular Python version called `pyaus`, contained in the `pyaus` directory, and a Cython version called `caus`, contained in the `caus` directory.\r\n\r\n## Building and installation\r\n1. If you are running Windows, you can simply run the command `pip install aus-python` to install a prepackaged version from PyPi.\r\n\r\n2. If you are not running Windows, or if you want to build and install the package manually, follow these instructions:\r\n \r\n 1. Before building this package, first decide whether you wish to use the Python version or the Cython version. Copy all of the .py files from `pyaus` or `caus` to the `aus` directory.\r\n\r\n 2. You will need to have a Python virtual environment with `build` installed in it. Alternatively, you can simply install `build` in your local Python installation. You may also need to install the packages `Cython`, `numpy`, and `setuptools` to build the package.\r\n\r\n 3. Run the command `python -m build`. The package will be located in the `dist` directory, in both `.whl` and `.tar.gz` format.\r\n\r\n 4. To install the package in your local Python installation, simply navigate to the `dist` directory and run the command `pip install filename.whl` (replace `filename` with the actual name of the file in the `dist` directory).\r\n\r\n 5. You are now ready to import `aus` into your Python code. Note that the package name is `aus-python`, because PyPi would not let me use the name `aus`. However, when importing into your Python code, you use the line `import aus.audiofile` or `import aus.operations` etc.\r\n\r\n## Documentation\r\nDocumentation is available at https://aus.readthedocs.io/en/latest/.\r\n\r\n## Dependencies\r\nYou will need the following Python libraries: `matplotlib`, `numpy`, `pedalboard`, `regex`, `scipy`. You will also need `Cython` if you want to build the Cython version.\r\n\r\n## Modules\r\nThe package is divided into 8 modules:\r\n\r\n### `aus.analysis`\r\nTools for spectral analysis and analysis of audio waveforms. Many of these tools are based on formulas from Florian Eyben's \"Real-Time Speech and Music Classification,\" published by Springer in 2016. Among other things, this module computes spectral centroid, entropy, slope, and flatness.\r\n\r\n### `aus.audiofile`\r\nThis module is for reading and writing audio files, using either the `pedalboard` library or using (slower) code provided here.\r\n\r\n### `aus.granulator`\r\nFuntionality for grain extraction\r\n\r\n### `aus.operations`\r\nThis module has various operations that can be performed on audio, such as spectral frame swapping, equal energy forcing, dc bias removal, and beat envelope generation.\r\n\r\n### `aus.plot`\r\nPlotting functionality for audio and spectrum\r\n\r\n### `aus.sampler`\r\nTools for extracting samples from audio\r\n\r\n### `aus.spectrum`\r\nTools for spectral analysis\r\n\r\n### `aus.synthesis`\r\nTools for generating simple waveforms\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A package with functionality for offline audio processing",
"version": "0.0.31",
"project_urls": {
"Homepage": "https://fleximeter.github.io/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b44532f7428ed3e7935be6f5ad0fb02a204fb6acb28eec0a95b926a9b07220f2",
"md5": "792f5ffa2eb64c670c99984add6899cc",
"sha256": "baf34ebeb765af5a9b8907ca3e0076da0535b639413f2d5161b6775d6c0669c7"
},
"downloads": -1,
"filename": "aus_python-0.0.31-py3-none-any.whl",
"has_sig": false,
"md5_digest": "792f5ffa2eb64c670c99984add6899cc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 39382,
"upload_time": "2024-10-20T18:07:59",
"upload_time_iso_8601": "2024-10-20T18:07:59.594134Z",
"url": "https://files.pythonhosted.org/packages/b4/45/32f7428ed3e7935be6f5ad0fb02a204fb6acb28eec0a95b926a9b07220f2/aus_python-0.0.31-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5102d1a633b40dc71f1f7ada9e7a99f8cb107810699d5b2c17566795a60fde65",
"md5": "d15ac4d470715790208f88a4154d2ff4",
"sha256": "eeac6df662194488e73848ef1886b4cdbfd86c4820525e4c42ee05ec7b7a69f4"
},
"downloads": -1,
"filename": "aus_python-0.0.31.tar.gz",
"has_sig": false,
"md5_digest": "d15ac4d470715790208f88a4154d2ff4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 91410,
"upload_time": "2024-10-20T18:08:00",
"upload_time_iso_8601": "2024-10-20T18:08:00.622748Z",
"url": "https://files.pythonhosted.org/packages/51/02/d1a633b40dc71f1f7ada9e7a99f8cb107810699d5b2c17566795a60fde65/aus_python-0.0.31.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 18:08:00",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "aus-python"
}
