Merge branch 'release/1.0.0'

Author: George Ciesinski

.gitignore

@@ -3,3 +3,6 @@ __pycache__/
 Logs/*
 !Logs/.logfolder.txt
 venv/
+build/*
+dist/*
+app.spec

CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2020-01-16
+### Added
+- Debugging print lines removed
+- App prints all of the shortcuts and directories during start
+- Better logging to track potential issues
+
+## [0.0.1] - 2020-01-14
+### Added
+- Created first basic version
+- Functional textblock printing and shortcut recognition
+- Released as alpha for testing purposes

TextController.py

@@ -79,9 +79,6 @@ def keycode_to_keydata(self):
         self.keydata = str(self.key)
         self.keydata = self.keydata.strip("'")
 
-        # Prints typed letter to console
-        print(self.keydata)
-
     def check_delimiter(self):
         """
         Checks if delimiter has been entered. Either starts self.current_word or restarts it.
@@ -187,7 +184,6 @@ def find_file_directory(self, index):
         # Searches self.file_dir_list by index for the directory
         textblock_directory = self.file_dir_list[index]
         self.log.debug(f"Successfully found the textblock directory: {textblock_directory}")
-        print(textblock_directory)
 
         # Reads the textblock file
         self.read_textblock(textblock_directory)

app.py

@@ -22,6 +22,8 @@
     # Creates shortcut list with the same index
     shortcut_list = glib.list_shortcuts(file_list)
 
+    glib.print_shortcuts(file_dir_list, shortcut_list)
+
     # Initializes KeyboardEmulator instance
     k = KeyboardEmulator(L)
 

glib.py

@@ -11,7 +11,8 @@ def list_subdirectories(directory):
     Lists all subdirectories.
 
     :param directory:
-    :return:
+    :return directory_list:
+    :rtype list:
     """
 
     directory_list = list()
@@ -20,15 +21,15 @@ def list_subdirectories(directory):
         for name in dirs:
             directory_list.append(os.path.join(root, name))
 
-    print(directory_list)
+    return directory_list
 
 
 def list_files(directory):
     """
     Lists all files and subdirectories in the directory. Returns list
 
     :param directory:
-    :return file_list:
+    :return file_list, file_dir_list:
     :rtype list:
     """
 
@@ -40,12 +41,17 @@ def list_files(directory):
             file_list.append(name)
             file_dir_list.append(os.path.join(root, name))
 
-    print(file_dir_list)
-
     return file_list, file_dir_list
 
 
 def list_shortcuts(file_list):
+    """
+    list_shortcuts creates a list of the raw shortcut strings the user would be typing in
+
+    :param file_list:
+    :return shortcut_list:
+    :rtype list:
+    """
 
     shortcut_list = list()
 
@@ -56,6 +62,13 @@ def list_shortcuts(file_list):
     return shortcut_list
 
 
+def print_shortcuts(file_dir_list, shortcut_list):
+
+    for file_dir in file_dir_list:
+        index = file_dir_list.index(file_dir)
+        print(f"Shortcut: {shortcut_list[index]}   - - -    Directory: {file_dir}")
+
+
 if __name__ == "__main__":
 
     text_block_dir = 'Textblocks/'