docstring improvements and requirements cleanup

.gitignore

@@ -1,13 +1,9 @@
 .DS_Store
 *.pyc
-stat_key_browser.egg-info
-build
 dist
 env
 .coverage
-keys.json
 .cache
-app.html
 stat_key_browser/data/key_cats.json
 stat_key_browser/data/key_tags.json
 web_app/js/keys.js

README-dev.md

@@ -2,11 +2,11 @@
 [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/isilon/isilon_stat_browser.svg)](http://isitmaintained.com/project/isilon/isilon_stat_browser "Average time to resolve an issue")
 [![Percentage of issues still open](http://isitmaintained.com/badge/open/isilon/isilon_stat_browser.svg)](http://isitmaintained.com/project/isilon/isilon_stat_browser "Percentage of issues still open")
 
-#stat-key-browser
+#Statistics Key Browser Development
 
 A single page web app that provides a browsable, searchable view of Isilon statistics keys. A Python script generates the html by querying an Isilon cluster for the list of statistics keys, then organizing and categorizing the keys before outputting the html app to web_app.
 
-##requirements
+##Requirements
 Python: 2.7, 3.3, 3.4, 3.5
 
 Dependencies listed in requirements-dev.txt
@@ -27,25 +27,14 @@ Isilon SDK Python language bindings
 
 `pip install -r requirements-dev.txt`
 
-### Build the html and js output in ./webapp:
-
-`./build_stat_browser`
-
-### Build a distributable zip file:
-The build will pause to request cluster IP, username and password.
-
-`make dist`
-
-### Build a distributable zip file non-interactively:
-
-Supply the cluster IP, username and password when building via automation.
-
-`make dist BUILD_BROWSER_ARGS='-c <cluster IP> -u <username> -p <password>'`
-
 ### Run unit tests:
 
 `make unittests`
 
+### Check unit test coverage:
+
+`make coverage`
+
 ### Run functional tests:
 The functional tests are only a stub currently.
 
@@ -55,6 +44,17 @@ The functional tests are only a stub currently.
 
 `./build_stat_browser.py -c <cluster IP>`
 
+### Generate a distributable zip file:
+The build will pause to request cluster IP, username and password.
+
+`make dist`
+
+### Generate a distributable zip file non-interactively:
+
+Supply the cluster IP, username and password when building via automation.
+
+`make dist BUILD_BROWSER_ARGS='-c <cluster IP> -u <username> -p <password>'`
+
 # Release process
 
 **Note:**

hexaparse.py

@@ -1,6 +1,8 @@
 #! /usr/bin/env python
 """
-Parse a hexa key/lists-of-values doc into a dict.
+Parse a hexa key/lists-of-values doc into a list of dicts.
+
+Each list item is a dict. The contain lists referenced by keyname.
 
 -Input-
 ::::::
@@ -27,6 +29,7 @@
 import logging
 import pytest
 
+
 def is_new_block(line):
     """Determine whether a string marks a new block."""
     if re.match('::::::$', line):
@@ -44,6 +47,7 @@ def is_key(line):
     else:
         return False
 
+
 def is_comment(line):
     """Determine whether a string is a key."""
     if re.match('#', line):

requirements-dev.txt

@@ -4,3 +4,4 @@ pytest-cov>=2.2.1
 mock>=2.0.0
 jinja2>=2.8
 pylint>=1.5.5
+urllib3 >= 1.15

requirements.txt

@@ -1,2 +1,3 @@
 future>=0.15.2
 jinja2>=2.8
+urllib3 >= 1.15