A tool for comparing file versions

Diff Tool is a tool for comparing 2 different versions of the same file. It produces an .html file as output this file contains the results of the diff comparison.

The .gitignore file has been set up to ignore config files with a naming convention of *.local.json so when testing locally, you can copy config.json to config.local.json and use your own directory structure. Also, archive files in the versions directory have been set to ignore as a privacy measure to potential users/contributors.

• os
• time
• json
• sys
• jsonschema
• uuid
• zipfile
• re
• Tkinter

• Windows 10
• Ubuntu 16.04.2 LTS

• remove directories from config object
• add project name to title in html doc
• lines with just blank space don't show up on html doc
• give html doc the name of the project
• where should html docs go?
• when loading a project in Linux, file name is case sensitive
• ability to delete a project
• search projects based on search string
• make sure file loading and other operations have try catch statements
• if no project is loaded, dont allow user to access compare option
• project info in html diff header div
• merge versionControl.py and project.py
• zip files are to be stored in zip directory (currently stored in root directory)
• add latest version number to project schema to keep track of latest version index
• check to see if project already exists when creating a new project (based on project name only)
• increase functionality of diff code, it should look to see if 0 or more characters are different between each line on each file
• organize app so common code goes into globalFunc.py
• insure that all config parameters are being used in the app
• global project for app (currently opened project)
• project schema (update config schema)
• projects directory
• projects will be created as json files
• load project
• save project
• come up with UI for command line
• allow user to create a project (means loading a file for the first time)
• allow user to open a project (opening lists all versions of the 'project' aka file)
• project management ability (edit, rename, update, add new versions, compare)
• allow user to select 2 versions in the project to compare
• allow user to change config items
• UI validation (in case incorrect data is entered) for command line UI
• compare two files (.txt files in this first version) for addition and/or subtraction only (in this first version 05/04/2017)
• write differences to html file
• generate html
• create "project" to keep file versions contained within
• zip archive of project contains all file versions
• when reading from zip file, determine latest version to compare with currently selected version
• come up with file versioning scheme (i.e. file_v_000_timestamp.txt)
• create JSON schema files for config and theme
• validate against those schemas to ensure app can run correctly
• adjust theme.json structure to be more conducive for translating to css
• implement saving in config.py (write to json file)
• load theme json and create basic css structure
• decide layout for html output file
• Windows/Linux cross platform

• config.json: holds configuration items for the app

{
	"theme": "defaultTheme.json",
	"themeDirectory": "C:\\DiffTool\\Themes",
	"themes": [{
			"name": "defaultTheme",
			"file": "defaultTheme.json"
		},
		{
			"name": "darkTheme",
			"file": "darkTheme.json"
		}
	],
	"name": "Diff Tool",
	"description": "A file comparing tool",
	"author": "Aaron Horeth"
}

• configSchema.json: the schema for proper config file layout

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"title": "Config",
	"description": "Configuration object",
	"type": "object",
	"properties": {
		"name": {
			"description": "Name of the application",
			"type": "string"
		},
		"author": {
			"description": "Author of the application",
			"type": "string"
		},
		"themes": {
			"type": "array",
			"items": {"$ref": "#/definitions/name", "$ref": "#/definitions/file"},
			"definitions": {
				"name": {
					"type": "string"
				},
				"file": {
					"type": "string"
				}
			}
		},
		"theme": {
			"description": "Default theme",
			"type": "string"
		},
		"description": {
			"description": "Description of the application",
			"type": "string"
		}
	}
}

• theme.json: holds theme (css styles) for the diff .html page output

{
	"name": "Default Theme",
	"author": "Aaron Horeth",
	"date": "April 25, 2017",
	"description": "This is the default theme, it consists of a dark page background color with a lighter diff region.",
	"body": [
		"body {margin: 0 auto; background-color: #171738;}"
	],
	"main": [
		"#main {position:absolute;top:0;bottom:0;left:0;right:0;padding:10px;}",
		".diff {font-family:\"Lucida Console\",\"Courier New\",monospace; background-color:#efeae6;}"
	],
	"diffHeader": [
		"#diffHeader {position:absolute;top:0;bottom:0;left:0;right:0;padding:10px;}"
	],
	"diffBody": [
		"#diffBody {}",
		"#diffLine {}",
		".diffChange {font-weight: bold;}",
		".diffLineAddition {foreground: #ff6b6b; background-color: #4ecdc4;}",
		".diffLineSubtraction {foreground: #8bb174; background-color: #b6465f;}"
	]
}

• themeSchema.json: the schema for proper theme file layout

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"title": "Theme",
	"description": "Theme objects",
	"type": "object",
	"properties": {
		"name": {
			"description": "Name of the theme",
			"type": "string"
		},
		"author": {
			"description": "Author of the theme",
			"type": "string"
		},
		"description": {
			"description": "Description of the theme",
			"type": "string"
		},
		"body": {
			"type": "array"
		},
		"main": {
			"type": "array"
		},
		"diffHeader": {
			"type": "array"
		},
		"diffBody": {
			"type": "array"
		}
	}
}

• project.json: the json data for projects

{
	"description" : "test",
	"createDate" : "May 05, 2017",
	"name" : "test",
	"author" : "test",
	"guid": "f7a905e3-7c7e-419f-b822-37dc86dd3ecf",
	"latestVersion": 1
}

• projectSchema.json: the schema for proper project layout

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"title": "Project",
	"description": "Project objects",
	"type": "object",
	"properties": {
		"name": {
			"description": "Name of the project",
			"type": "string"
		},
		"author": {
			"description": "Author of the project",
			"type": "string"
		},
		"description": {
			"description": "Description of the project",
			"type": "string"
		},
		"createDate": {
			"description": "Date the project was created",
			"type": "string"
		},
		"guid": {
		    "description": "GUID that identifies the project in the version directory",
		    "type": "string"
		},
		"latestVersion": {
			"description": "The latest version of the file",
			"type": "integer"
		}
	}
}

Table Generator: Markdown Tables Generator

Markdown Editor: DILLINGER

CSS Color Scheme: coolors

JSON Validator: JSONLint