The new `pluginutils` module contains the TTS formatting functions
previously only defined in the Dark Sky plugin. This change comes
because these functions are of general utility, and may eventually
be configurable in one centralized place for all of Kaylee.

README.rst

Kaylee======

Kaylee is a somewhat fancy voice command recognition program thatperforms actions when a user speaks loosely preset sentences. It has aflexible plugin API allowing developers to add new advanced featuresthat can be distributed and loaded with ease.

Kaylee is based on `Blather <https://gitlab.com/jezra/blather>`__ by`Jezra <http://jezra.net/>`__, but adds a lot of features that gobeyond the original purpose of Blather.

Installation------------

Kaylee is only tested on GNU/Linux systems, so make sure you're tryingto install it on one of those. The current recommended way to use Kayleeis to check out the Git repository and run it from there::

**Note:** it may also be required to install``pocketsphinx-hmm-en-hub4wsj``

Optional Dependencies~~~~~~~~~~~~~~~~~~~~~

1. python-pydbus (required for MPRIS plugin)

Usage-----

1. Copy plugins.json.dist to ~/.config/kaylee/plugins.json and fill the ".shell" section of the file with sentences to speak and commands to run.2. Run Kaylee with ``./kaylee.py``. This generates a language model and dictionary using the `Sphinx Knowledge Base Tool <http://www.speech.cs.cmu.edu/tools/lmtool.html>`__, then listens for commands with the system default microphone. To use a microphone other than the system default, use the ``-m`` flag.3. Start talking!