amine@369: Installation
amine@369: ------------
amine@369: 
amine@369: .. code:: bash
amine@369: 
amine@369:     pip install auditok
amine@369: 
amine@369: 
amine@369: A basic version of ``auditok`` will run with standard Python (>=3.4). However,
amine@369: without installing additional dependencies, ``auditok`` can only deal with audio
amine@369: files in *wav* or *raw* formats. if you want more features, the following
amine@369: packages are needed:
amine@369: 
amine@369:     - `pydub <https://github.com/jiaaro/pydub>`_ : read audio files in popular
amine@369:        audio formats (ogg, mp3, etc.) or extract audio from a video file.
amine@369:     - `pyaudio <http://people.csail.mit.edu/hubert/pyaudio/>`_ : read audio data
amine@369:        from the microphone and play back detections.
amine@369:     - `tqdm <https://github.com/tqdm/tqdm>`_ : show progress bar while playing
amine@369:        audio clips.
amine@369:     - `matplotlib <http://matplotlib.org/>`_ : plot audio signal and detections.
amine@369:     - `numpy <http://www.numpy.org>`_ : required by matplotlib. Also used for
amine@369:        some math operations instead of standard python if available.