.. highlight::  python

Welcome to pi-clap
==================

**A python package for clap detection**

Contents
^^^^^^^^

.. toctree::
  :maxdepth: 5
  :caption: Contents

  Introduction <self>
  install
  documentation
  tutorial
  license

.. toctree::
  :caption: Links
  :hidden:

  MagPi Tutorial <https://magpi.raspberrypi.org/articles/raspberry-pi-clapper>
  Python Package <https://pypi.org/project/pi-clap/>
  Source Code <https://github.com/nikhiljohn10/pi-clap>
  genindex


Platforms Supported
^^^^^^^^^^^^^^^^^^^

* Raspberry Pi
* Linux
* MacOS


Hardware Requirements
^^^^^^^^^^^^^^^^^^^^^

* Raspberry Pi (optional)
* Bread Board (optional)
* Microphone
* Audio Card (Needed for analog microphones with a jack)

Dependencies
^^^^^^^^^^^^

* `Python 3.6+ <https://docs.python.org/3/>`_
* `PyAudio <https://pypi.org/project/PyAudio>`_

  * `PortAudio <http://www.portaudio.com/>`_ (Need to be installed manually)
  * Audio Driver (Automatically loaded by OS after a restart)

* `Munch <https://pypi.org/project/munch/>`_

Upcoming features
^^^^^^^^^^^^^^^^^

* Adding advanced clap detection algorithms
* Adding support for automation platforms like Amazon Alexa, Google Home, IFTTT etc.

License
^^^^^^^

MIT License

.. meta::
   :description: pi-clap - A python package for clap detection
   :keywords: pi-clap, clap detection, python package