MOD: updated docs with more examples

docs/README

@@ -33,14 +33,51 @@ The fingerprint can be used for historical comparisons to see what has changed i
   USAGE
 -------------
 
+Create fingerprings from given path
+find <db_files_path> -exec python dbfp.py -db {} \;
+
+Attempt to fingerprint all files with *.db
+find . -type f -name "*.db" -exec python dbfp.py -db {} \;
+
+Attempt to fingerprint all files, recursively, from this path (no error if file not database)
+find . -type f -exec python dbfp.py -db {} \;
+
+
+
 ***** ***** ***** *****
    DB Fingerprint
 ***** ***** ***** *****
 
+Create fingerprint:
+  dbfp.py  -db <database_file>
+
+Create fingerprint index:
+  dbfp.py  -fd <fingerprint_dir> -idx
+
+Add fingerprint to index:
+  dbfp.py  -fp <fingerprint_file> -idx (-db <database_file> | -fp <fingerprint_file>)
+
+Compare fingerprint to a database file:
+  dbfp.py  -fp <fingerprint_file> -db <database_file>
+
+Lookup fingerprint from index:
+  dbfp.py  -fd <fingerprint_dir> -fp <fingerprint_file>)
+
+Lookup database from index:
+  dbfp.py  -fd <fingerprint_dir> -db <database_file>
+
+Lookup MD5 hash from index:
+  dbfp.py  -fd <fingerprint_dir> -md5 <md5_hash_string>
+
+Android App pull and fingerprint:
+  dbfp.py -android_pull
+
+***** ***** ***** *****
+
 usage: dbfp.py [-h] [-db DATABASE] [-fd FPDIR] [-fp FINGERPRINT]
-               [-ad ANDROID_DIR] [-dd DATA_DIR] [-idx INDEX_FINGERPRINTS]
+               [-ad ANDROID_DIR] [-dd DATA_DIR] [-an APP_NAME]
-               [-md5 MD5] [-an APP_NAME] [-av APP_VERSION] [-n NOTES] [-idxf]
+               [-av APP_VERSION] [-n NOTES] [-idx] [-md5 MD5] [-android_pull]
-               [-android_pull] [-v] [-vv] [-l]
+               [-v] [-vv] [-l]
 
 Fingerprint a sqlite database based on its schema
 
@@ -49,7 +86,8 @@ optional arguments:
   -db DATABASE, --database DATABASE
                         path to file to be fingerprinted
   -fd FPDIR, --fpdir FPDIR
-                        path to directory of fingerprint files
+                        path to directory of fingerprint files, compare each
+                        file
   -fp FINGERPRINT, --fingerprint FINGERPRINT
                         fingerprint file to use in comparison
   -ad ANDROID_DIR, --android_dir ANDROID_DIR
@@ -57,16 +95,14 @@ optional arguments:
                         sqlite files
   -dd DATA_DIR, --data_dir DATA_DIR
                         path to a directory to search for sqlite files
-  -idx INDEX_FINGERPRINTS, --index_fingerprints INDEX_FINGERPRINTS
-                        path to a directory with sqlite files
-  -md5 MD5              md5 hash to query the index`
   -an APP_NAME, --app_name APP_NAME
   -av APP_VERSION, --app_version APP_VERSION
   -n NOTES, --notes NOTES
-  -idxf                 add a fingerprint to the index
+  -idx                  add a fingerprint to the index
+  -md5 MD5              md5 hash to query the index`
   -android_pull         automated pull of applications from a physical android
                         phone
   -v, --verbose         will set logging level to INFO
   -vv, --vverbose       will set logging level to DEBUG
   -l, --logging         will supercede the -v option and send all logging to a
-                        file, logging.DEBUG
+                        file, logging.DEBUG

tests/test_fingerprint.py

@@ -2,7 +2,6 @@ import unittest
 from libs.fingerprint import FingerprintDB
 
 
-# Here's our "unit tests".
 class FingerprintTestCase(unittest.TestCase):
 	
 	def setUp(self):
@@ -13,6 +12,7 @@ class FingerprintTestCase(unittest.TestCase):
     #self.failUnless(True)
 
   def testWriteFingerprint(self, filename):
+
     self.failIf(True)
 
   def testWriteFingerprintFile(self, filename):