From f1b44dfbb8e8e623d7077c218d3841357b09caec Mon Sep 17 00:00:00 2001 From: JohnE Date: Thu, 25 Jun 2015 10:59:34 -0700 Subject: [PATCH] FIN: readme docs --- README | 17 +++++++++++++++++ RELEASE_NOTES | 22 ++++++++++++++++++++++ docs/README | 31 +++++++++++++++++++++++++++++++ 3 files changed, 70 insertions(+) create mode 100644 README create mode 100644 RELEASE_NOTES create mode 100644 docs/README diff --git a/README b/README new file mode 100644 index 0000000..944cd2b --- /dev/null +++ b/README @@ -0,0 +1,17 @@ + ================== + DB Fingerprint + ================== + + +------------- + INTRO +------------- +dbfp is a tool that will scan a sqlite database and generate a fingerprint. +The fingerprint is basically the database schema. +The fingerprint is stored to disk in JSON format. + + +------------- + BUILD +------------- + diff --git a/RELEASE_NOTES b/RELEASE_NOTES new file mode 100644 index 0000000..84586d3 --- /dev/null +++ b/RELEASE_NOTES @@ -0,0 +1,22 @@ + +--------------- + Future Work +--------------- +1. Fuzzy Logic database schema detection + + +------------ + History +------------ + +version 0.9 + -added JSON import + -added database schema comparison. currently only compares + +version 0.8 + -updated fingerprint to include SQLite database commands to create the tables + -updated fingerprint to include file metadata which is version of the fingerprint JSON file format + +version 0.7 + - export a database fingerprint to a JSON file + diff --git a/docs/README b/docs/README new file mode 100644 index 0000000..bc15a5e --- /dev/null +++ b/docs/README @@ -0,0 +1,31 @@ + ================== + DB Fingerprint + ================== + + +------------- + INTRO +------------- + +dbfp is a tool that will scan a sqlite database and generate a fingerprint. +The fingerprint is basically the database schema. +The fingerprint is stored to disk in JSON format. + + +------------- + USAGE +------------- + +***** ***** ***** ***** + DB Fingerprint +***** ***** ***** ***** + +usage: main.py [-h] [-f FILE] [-j JSON] [-v] + +Fingerprint a sqlite database based on its schema + +optional arguments: + -h, --help show this help message and exit + -f FILE, --file FILE + -j JSON, --json JSON + -v, --verbose