Restructure scripts folder. Added detailed help to command line help. Extended README file to describe the available scripts.

Author: alanlgardner

.gitignore

@@ -0,0 +1,2 @@
+.project
+.pydevproject

README

@@ -0,0 +1,36 @@
+=Funf Data Processing=
+
+This project contains convenience scripts for processing Funf data files.  
+These files are designed to be used as standalone scripts, and not as a library to be imported.
+Make sure to download and install the dependencies before running the scripts.
+
+
+==Data Processing==
+Scripts for processing data once it has been retrieved from devices.
+
+Dependencies:
+	* PyCrypto ( https://www.dlitz.net/software/pycrypto/ )
+
+
+===decrypt.py===
+Decrypts files using the DES key specified, or the one included in this script.  Keeps a backup copy of the original file.  
+*WARNING:* This script does not detect if a file has already been decrypted. Decrypting a file that is not encrypted will scramble the file.
+
+===dbdecrypt.py===
+Safe script for decrypting sqlite3 db files.  Checks to see if the file can be opened by Sqlite.  Only if it cannot open the file, it decrypts it.
+
+===dbmerge.py===
+Merge many database files into one file.
+
+
+
+==Simple Server==
+A basic reference HTTP server for communicating with Funf applications.  
+The server hosts one configuration file (/config), and accepts multipart form uploads of files (/data).
+
+This is meant to be a reference implementation for prototyping, and not meant to be a stable long running implementation.
+
+
+
+
+

data_processing/.gitignore

@@ -1,3 +1,6 @@
+.project
+.pydevproject
+
 merged*
 uploads*
 *.pyc

data_processing/.project

@@ -34,7 +34,9 @@ def decrypt_if_not_db_file(file_name, extension=None):
             shutil.move(file_name + "." + extension, file_name)
 
 if __name__ == '__main__':
-    parser = OptionParser(usage="usage: %prog [options] [sqlite_file1.db [sqlite_file2.db...]]")
+    usage = "%prog [options] [sqlite_file1.db [sqlite_file2.db...]]"
+    description = "Safely decrypt Sqlite3 db files.  Checks to see if the file can be opened by Sqlite.  If so, the file is left alone, otherwise the file is decrypted.  Uses the decrypt script, so it always keeps a backup of the original encrypted files. "
+    parser = OptionParser(usage="%s\n\n%s" % (usage, description))
     parser.add_option("-i", "--inplace", dest="extension", default=None,
                       help="The extension to rename the original file to.  Will not overwrite file if it already exists. Defaults to '%s'." % decrypt.default_extension,)
     (options, args) = parser.parse_args()

data_processing/README

@@ -59,9 +59,11 @@ def merge(db_files=None, out_file=None):
 
 
 if __name__ == '__main__':
-    parser = OptionParser(usage="usage: %prog [options] [sqlite_file1.db [sqlite_file2.db...]]")
+    usage = "%prog [options] [sqlite_file1.db [sqlite_file2.db...]]"
+    description = "Merges many database files into one file."
+    parser = OptionParser(usage="%s\n\n%s" % (usage, description))
     parser.add_option("-o", "--output", dest="file", default=None,
-                      help="Filename to merge all files into.  Created if it doesn't exist.", metavar="FILE")
+                      help="Filename to merge all files into.  Will not overwrite a file if it already exists.", metavar="FILE")
     (options, args) = parser.parse_args()
     try:
         merge(args, options.file)

data_processing/dbdecrypt.py

@@ -10,9 +10,10 @@
 _des_key = string.join([chr(byte) for byte in (12,34,45,54,27,122,33,45)], '')
 default_extension = "orig"
 
-def decrypt(file_names, extension=None):
+def decrypt(file_names, extension=None, key=None):
     extension = extension or default_extension
-    decryptor = DES.new(_des_key)
+    key = key or _des_key
+    decryptor = DES.new(key)
     for file_name in file_names:
         with open(file_name) as file:
             encrypted_data = file.read()
@@ -25,8 +26,12 @@ def decrypt(file_names, extension=None):
 
 
 if __name__ == '__main__':
-    parser = OptionParser(usage="usage: %prog [options] [file1 [file2...]]")
+    usage = "%prog [options] [file1 [file2...]]"
+    description = "Decrypts files using the DES key specified, or the one included in this script.  Keeps a backup copy of the original file.  \nWARNING: This script does not detect if a file has already been decrypted.  \nDecrypting a file that is not encrypted will scramble the file."
+    parser = OptionParser(usage="%s\n\n%s" % (usage, description))
     parser.add_option("-i", "--inplace", dest="extension", default=None,
                       help="The extension to rename the original file to.  Will not overwrite file if it already exists. Defaults to '%s'." % default_extension,)
+    parser.add_option("-k", "--key", dest="key", default=None,
+                      help="The DES key used to decrypt the files.  Uses the default hard coded one if one is not supplied.",)
     (options, args) = parser.parse_args()
     decrypt(args, options.extension)

data_processing/dbmerge.py

@@ -0,0 +1,2 @@
+.project
+.pydevproject