amine@369: Installation
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@377: - `pydub <https://github.com/jiaaro/pydub>`_ : read audio files in popular audio formats (ogg, mp3, etc.) or extract audio from a video file.
amine@377: - `pyaudio <https://people.csail.mit.edu/hubert/pyaudio>`_ : read audio data from the microphone and play audio back.
amine@377: - `tqdm <https://github.com/tqdm/tqdm>`_ : show progress bar while playing audio clips.
amine@377: - `matplotlib <https://matplotlib.org/stable/index.html>`_ : plot audio signal and detections.
amine@377: - `numpy <https://numpy.org/>`_ : required by matplotlib. Also used for some math operations instead of standard python if available.
amine@377: 
amine@377: 
amine@377: Install the latest stable version with pip:
amine@377: 
amine@377: .. code:: bash
amine@377: 
amine@377:     sudo pip install auditok
amine@377: 
amine@377: Install with the latest development version from github:
amine@377: 
amine@377: .. code:: bash
amine@377: 
amine@377:     pip install git+https://github.com/amsehili/auditok
amine@377: 
amine@377: or
amine@377: 
amine@377: .. code:: bash
amine@377: 
amine@377:     git clone https://github.com/amsehili/auditok.git
amine@377:     cd auditok
amine@377:     python setup.py install