wavescout


Namewavescout JSON
Version 0.1.0 PyPI version JSON
download
home_page
SummaryA lightweight module for easy beatmapping, key detection, and smart-slicing
upload_time2023-04-16 23:53:34
maintainer
docs_urlNone
authorDJ Stomp
requires_python>=3.10,<4.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# WaveScout

WaveScout is a lightweight Python library for quickly analyzing the tempo and key of audio files and slicing them into smaller segments based on measures.

## Features

- Analyzes tempo (BPM) and key of audio files
- Generates beat maps for audio files
- Slices audio files into smaller segments based on measures
- Exports plaintext beat map files and audio slices as a zip file
- Supports processing multiple audio files in a directory

## Installation

You can install WaveScout using pip:

```bash
pip install wavescout
```

## Dependencies

- numpy
- aubio
- pydub

## Usage

Here's a simple example of using WaveScout:

```python
from wavescout import WaveScout

# Analyze the audio file
scout = WaveScout("path/to/your/audio_file.mp3")

# Export the beat map to a plaintext file
scout.export("beat_map.txt")

# Export the audio slices to a zip file
scout.export("slices.zip", export_slices=True)
```

You can also use WaveScout to analyze and process multiple audio files in a directory:

```python
from wavescout import WaveScoutFactory

factory = WaveScoutFactory("path/to/your/audio_files_directory")
maps = factory.create_maps()

for map in maps:
    map.export(f"{map.input_file_basename}_beat_map.txt")
    map.export(f"{map.input_file_basename}_slices.zip", export_slices=True)
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "wavescout",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "DJ Stomp",
    "author_email": "85457381+DJStompZone@users.noreply.github.com",
    "download_url": "https://files.pythonhosted.org/packages/0d/1d/ee9755657f735a09a2f5adfaa212b070c90a649eba27a42ca6fedb20ca49/wavescout-0.1.0.tar.gz",
    "platform": null,
    "description": "\n# WaveScout\n\nWaveScout is a lightweight Python library for quickly analyzing the tempo and key of audio files and slicing them into smaller segments based on measures.\n\n## Features\n\n- Analyzes tempo (BPM) and key of audio files\n- Generates beat maps for audio files\n- Slices audio files into smaller segments based on measures\n- Exports plaintext beat map files and audio slices as a zip file\n- Supports processing multiple audio files in a directory\n\n## Installation\n\nYou can install WaveScout using pip:\n\n```bash\npip install wavescout\n```\n\n## Dependencies\n\n- numpy\n- aubio\n- pydub\n\n## Usage\n\nHere's a simple example of using WaveScout:\n\n```python\nfrom wavescout import WaveScout\n\n# Analyze the audio file\nscout = WaveScout(\"path/to/your/audio_file.mp3\")\n\n# Export the beat map to a plaintext file\nscout.export(\"beat_map.txt\")\n\n# Export the audio slices to a zip file\nscout.export(\"slices.zip\", export_slices=True)\n```\n\nYou can also use WaveScout to analyze and process multiple audio files in a directory:\n\n```python\nfrom wavescout import WaveScoutFactory\n\nfactory = WaveScoutFactory(\"path/to/your/audio_files_directory\")\nmaps = factory.create_maps()\n\nfor map in maps:\n    map.export(f\"{map.input_file_basename}_beat_map.txt\")\n    map.export(f\"{map.input_file_basename}_slices.zip\", export_slices=True)\n```\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A lightweight module for easy beatmapping, key detection, and smart-slicing",
    "version": "0.1.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "23b445c682b3e41fa3170de876860ebb9f0e36103091570b93ce7c741431c511",
                "md5": "925718782ae06acc982cbb10ba418da5",
                "sha256": "5d2379180f9bedd5913984e715358b46efd614b8e6d1c2ec859646ab652415b4"
            },
            "downloads": -1,
            "filename": "wavescout-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "925718782ae06acc982cbb10ba418da5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 4420,
            "upload_time": "2023-04-16T23:53:32",
            "upload_time_iso_8601": "2023-04-16T23:53:32.722564Z",
            "url": "https://files.pythonhosted.org/packages/23/b4/45c682b3e41fa3170de876860ebb9f0e36103091570b93ce7c741431c511/wavescout-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0d1dee9755657f735a09a2f5adfaa212b070c90a649eba27a42ca6fedb20ca49",
                "md5": "347d160622fc17424cdd1defe197db5a",
                "sha256": "75b0ccd4e04ee3b38081a2ecbff9b8d838b3f39c3cf0a8bf62ce9e511e79ec6e"
            },
            "downloads": -1,
            "filename": "wavescout-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "347d160622fc17424cdd1defe197db5a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 3576,
            "upload_time": "2023-04-16T23:53:34",
            "upload_time_iso_8601": "2023-04-16T23:53:34.542655Z",
            "url": "https://files.pythonhosted.org/packages/0d/1d/ee9755657f735a09a2f5adfaa212b070c90a649eba27a42ca6fedb20ca49/wavescout-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-04-16 23:53:34",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "wavescout"
}
        
Elapsed time: 0.15288s