Added a default configuration file

Previously, the default configuration file was only provided in a form
that was not included in distributions.  This could potentially
frustrate users by making it difficult to find a configuration file
example.  To remedy this, I moved it to be a package resource, imported
pkg_resources (setuptools is now a dependancy!), and made Kaylee load
both the default and the local configuration files, with the local of
course overriding the default.

README.rst

@@ -15,25 +15,24 @@ Requirements
 3. gstreamer-1.0 (and what ever plugin has pocketsphinx support)
 4. gstreamer-1.0 base plugins (required for ALSA)
 5. python-gobject (required for GStreamer and the GTK-based UI)
-6. python-requests (required for automatic language updating)
+6. python-requests
+7. python-setuptools
+
+**Note:** it may also be required to install
+``pocketsphinx-hmm-en-hub4wsj``
 
 Optional
 ~~~~~~~~
 
 1. python-pydbus (required for MPRIS plugin)
 
-**Note:** it may also be required to install
-``pocketsphinx-hmm-en-hub4wsj``
-
 Usage
 -----
 
-1. Copy options.json.tmp to ~/.config/kaylee/options.json.  Default
-   values for command-line arguments may be specified in this file.
-2. Copy plugins.json.tmp to ~/.config/kaylee/plugins.json and fill the
+1. Copy plugins.json.tmp to ~/.config/kaylee/plugins.json and fill the
    ".shell" section of the file with sentences to speak and commands
    to run.
-3. Run Kaylee with ``./kaylee.py``. This generates a language model and
+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.
@@ -60,6 +59,10 @@ Examples
 -  To run a command when an invalid sentence has been detected:
    ``./kaylee.py --invalid-sentence-command=/path/to/command``
 
+Default values for command-line arguments may be specified in
+~/.config/kaylee/options.json.  It is recommended to base this file on
+the default configuration file, kayleevc/conf/options.json.
+
 Finding the Device Number of a USB microphone
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

kayleevc/util.py

@@ -10,6 +10,7 @@ import os
 from argparse import ArgumentParser, Namespace
 from collections import OrderedDict
 
+import pkg_resources
 import requests
 
 from gi.repository import GLib
@@ -26,7 +27,9 @@ class Config:
     data_dir = os.path.join(GLib.get_user_data_dir(), program_name)
 
     # Configuration files
-    opt_file = os.path.join(conf_dir, "options.json")
+    default_opt_file = pkg_resources.resource_filename('kayleevc',
+        'conf/options.json')
+    local_opt_file = os.path.join(conf_dir, "options.json")
     plugins_file = os.path.join(conf_dir, "plugins.json")
 
     # Cache files
@@ -71,34 +74,27 @@ class Config:
                 dest="invalid_sentence_command", action='store',
                 help="Command to run when an invalid sentence is detected")
 
-        # Read the configuration file
-        self._read_options_file()
+        # Read the configuration files
+        self.options = self._read_json_file(self.default_opt_file)
+        self.options.update(self._read_json_file(self.local_opt_file))
+        self.options = Namespace(**self.options)
 
         # Parse command-line arguments, overriding config file as appropriate
         self._parser.parse_args(namespace=self.options)
 
         # Read the plugins file
-        self._read_plugins_file()
+        self.plugins = self._read_json_file(self.plugins_file)
 
     def _make_dir(self, directory):
         if not os.path.exists(directory):
             os.makedirs(directory)
 
-    def _read_options_file(self):
+    def _read_json_file(self, filename):
         try:
-            with open(self.opt_file, 'r') as f:
-                self.options = json.load(f, object_pairs_hook=OrderedDict)
-                self.options = Namespace(**self.options)
+            with open(filename, 'r') as f:
+                return json.load(f, object_pairs_hook=OrderedDict)
         except FileNotFoundError:
-            # Make an empty options namespace
-            self.options = Namespace()
-
-    def _read_plugins_file(self):
-        try:
-            with open(self.plugins_file, 'r') as f:
-                self.plugins = json.load(f, object_pairs_hook=OrderedDict)
-        except FileNotFoundError:
-            self.plugins = None
+            return {}
 
 
 class Hasher:

setup.py

@@ -25,7 +25,7 @@ setup(
         "Programming Language :: Python :: 3.5",
         "Topic :: Home Automation"
     ],
-    install_requires=["requests"],
+    install_requires=["requests", "setuptools"],
     data_files = [
         ("/usr/share/kaylee", ["data/icon_inactive.png", "data/icon.png",
             "options.json.tmp"]),