Installation

auditok requires Python 3.8 or higher.

Dependencies

The only required dependency is:

  • numpy: used for signal processing.

The following are optional and can be installed as needed:

  • sounddevice: to read audio data from a microphone and play audio back.

  • tqdm: to display a progress bar while playing audio clips.

  • matplotlib: to plot audio signals and detections.

For non-WAV audio formats (MP3, OGG, FLAC, etc.) or video files, ffmpeg must be installed and available on your PATH.

Install with pip

To install the latest stable version:

pip install auditok

To install with all optional dependencies:

pip install auditok[all]

You can also install specific optional groups:

pip install auditok[plot]       # matplotlib
pip install auditok[device-io]  # sounddevice + tqdm

Install from GitHub

To install the latest development version:

pip install git+https://github.com/amsehili/auditok

Or clone the repository:

git clone https://github.com/amsehili/auditok.git
cd auditok
pip install .