@@ -6,7 +6,7 @@ boobank-cacher: run 1 to n boobank commands and save their JSON output to file,

 along with a timestamp. boobank-cacher also handles "additions", i.e. the

 ability to insert simple, static data in the JSON output. boobank-cacher takes

 no command-line arguments: everything is read from

-~/.config/boobank-cacher/conf.json. See the conf subdirectory for a sample

+~/.config/boobank-utils/cacher.json. See the conf subdirectory for a sample

 configuration file.

 boobank-graphite: take a JSON file created by the "boobank list" command and

@@ -1,23 +1,35 @@

 #!/usr/bin/env python

 # -*- coding: utf-8 -*-

+"""

+boobank-cacher runs a list of boobank commands defined in its configuration

+file. For each command, it has the ability to inject simple, additional data to

+the result before saving it to a JSON file.

+That JSON file can then act as a local cache, which other tools can leverage

+for various purposes without emitting too many requests to bank websites.

+"""

 import os

 import re

-import sys

 import json

 import copy

 import time

-import errno

 import argparse

 import subprocess

-from boobank_utils import *

+from boobank_utils import mkdir, DEFAULT_CONF_DIR

 def get_conf(conf_path):

+    """

+    Return the contents of the boobank-cacher configuration.

+    """

     conf_path = os.path.expanduser(conf_path)

     with open(conf_path, 'r') as filedesc:

         return json.load(filedesc)

 def run_boobank(conf):

+    """

+    Pipe the commands found in the given boobank-cacher configuration to a

+    single boobank process and return their results.

+    """

     results = copy.deepcopy(conf)

     # Ensure there is at least one command to run:

     commands = results.get('commands', [])

@@ -25,7 +37,8 @@ def run_boobank(conf):

         return results

     boobank_path = os.path.expanduser(conf.get('boobank_path', 'boobank'))

     boobank_command = [boobank_path, '--formatter=json']

-    boobank_process = subprocess.Popen(boobank_command, stdin=subprocess.PIPE, stdout=subprocess.PIPE, close_fds=True, bufsize=-1)

+    boobank_process = subprocess.Popen(boobank_command, stdin=subprocess.PIPE,

+                                       stdout=subprocess.PIPE, close_fds=True, bufsize=-1)

     # Send all commands at once:

     for command in commands:

         boobank_process.stdin.write(command['command'] + "\n")

@@ -48,6 +61,10 @@ def run_boobank(conf):

     return results

 def process_additions(results):

+    """

+    Inject additional data described in the boobank-cacher configuration to the

+    given results.

+    """

     for command in results.get('commands', []):

         additions = command.get('additions', {})

         result = command.get('result', {})

@@ -64,6 +81,10 @@ def process_additions(results):

     return results

 def write_cache(results):

+    """

+    Write the given results to cache files as described in the boobank-cacher

+    configuration.

+    """

     for command in results.get('commands', []):

         if 'result' not in command or 'cache_path' not in command:

             continue

@@ -73,11 +94,20 @@ def write_cache(results):

             json.dump(command['result'], filedesc, indent=4)

 def parse_args():

-    args_parser = argparse.ArgumentParser(description='Cache the output of boobank commands to JSON files.')

-    args_parser.add_argument('-c', '--config', default=DEFAULT_CONF_FILE, help='configuration file to use')

+    """

+    Parse command-line arguments.

+    """

+    description = 'Cache the output of boobank commands to JSON files.'

+    args_parser = argparse.ArgumentParser(description=description)

+    default_conf = os.path.join(DEFAULT_CONF_DIR, 'cacher.json')

+    args_parser.add_argument('-c', '--config', default=default_conf,

+                             help='configuration file to use')

     return args_parser.parse_args()

 def main():

+    """

+    Main function.

+    """

     args = parse_args()

     conf = get_conf(args.config)

     results = run_boobank(conf)

@@ -10,7 +10,7 @@ import json

 import errno

 from termcolor import colored

-DEFAULT_CONF_FILE = '~/.config/boobank-cacher/conf.json'

+DEFAULT_CONF_DIR = '~/.config/boobank-utils'

 MAX_AGE = 24 * 60 * 60

 UNUSUAL_THRESHOLD = 500.0

similarity index 100%

rename from conf/boobank-cacher/conf.json

rename to conf/boobank-utils/cacher.json