MOD: updated the docs to reflect the latest changes

docs/README

@@ -38,8 +38,9 @@ The fingerprint can be used for historical comparisons to see what has changed i
 ***** ***** ***** *****
 
 usage: dbfp.py [-h] [-db DATABASE] [-fd FPDIR] [-fp FINGERPRINT]
-               [-dd DATA_DIR] [-idx INDEX_FINGERPRINTS] [-an APP_NAME]
-               [-av APP_VERSION] [-n NOTES] [-pull] [-v] [-l]
+               [-ad ANDROID_DIR] [-dd DATA_DIR] [-idx INDEX_FINGERPRINTS]
+               [-an APP_NAME] [-av APP_VERSION] [-n NOTES] [-android_pull]
+               [-v] [-vv] [-l]
 
 Fingerprint a sqlite database based on its schema
 
@@ -51,15 +52,20 @@ optional arguments:
                         path to directory of fingerprint files
   -fp FINGERPRINT, --fingerprint FINGERPRINT
                         fingerprint file to use in comparison
+  -ad ANDROID_DIR, --android_dir ANDROID_DIR
+                        path to a directory with android folder structure
+                        sqlite files
   -dd DATA_DIR, --data_dir DATA_DIR
-                        path to a directory with sqlite files
+                        path to a directory to search for sqlite files
   -idx INDEX_FINGERPRINTS, --index_fingerprints INDEX_FINGERPRINTS
                         path to a directory with sqlite files
   -an APP_NAME, --app_name APP_NAME
   -av APP_VERSION, --app_version APP_VERSION
   -n NOTES, --notes NOTES
-  -pull                 automated pull of applications from a physical android
+  -android_pull         automated pull of applications from a physical android
                         phone
-  -v, --verbose         will set logging level to DEBUG
+  -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
+

docs/README_DEV

@@ -25,8 +25,43 @@ It has been tested on Python 2.7.10
 The following is documentation regarding the usage of the various libraries included 
 with this tool.
 
-[ Fingerprint Library ]
+
+[[ Fingerprint Library ]]
+from libs.fingerprint import FingerprintDB
+from libs.fingerprint_index import FingerprintIndex
+
+
+[ Compare Fingerprint ]
+db = FingerprintDB()
+db.scanDBFile(file_in)
+percent = db.compareDB(file_json)
+print "Percent match: {}".format(str(percent))
+
+
+[ Compare Fingerprint Index ]
+db = FingerprintDB()
+db.scanDBFile(file_in)
+fp = FingerprintIndex()
+fp.openIndex(fp_dir)
+fp_list = fp.findFP(md5_db, md5_tables)
+results = []
+for fp in fp_list:
+    fq_fp = fp_dir + os.path.sep + fp
+    print "[ OPEN fingerprint ] [ {} ]".format(fq_fp)
+    percent = db.compareDB(fq_fp)
+    print "Percent: {}".format(str(percent))
 
 
 [ Fingerprint Index Library ]
+# create a fingerprint object
+fp = FingerprintIndex()
+
+# open the fingerprint index, this will create an index if not found
+# parm1: path to the fingerprint index directory
+fp.openIndex(fp_dir)
+
+# parm1: database schema md5
+# parm2: list of table schema md5
+# return: list of fingerprints to open and compare
+fp_list = fp.findFP(md5_db, md5_tables)
 

docs/RELEASE_NOTES

@@ -9,6 +9,17 @@
   History
 ------------
 
+version 0.97
+  -add more verbose output options to command line interface
+    "-v" is logging level INFO
+    "-vv" is logging level DEBUG
+  -changed android data switch from "-dd" to "-ad"
+  -changed command line option "-f" to "-db"
+  -changed command line option "-pull" to "-android_pull"
+  -fixed bugs introduced with the importJSON and the fingerprint index cmoparison feature
+  -bug fixes to the -db feature to allow for single filename, improved error messages in the command line tool
+  -code cleanup to be more consistant with print statements and exception handing when calling the API
+
 version 0.96
   -new feature, creates and index of the fingerprints for quick comparisons
   -"-fd" fingerprint directory, this directory should contain a lot of fingerprints