feat: moved to using the windows temp folder

feat: added installer compiler with Inno Setup
feat: opens the output folder for the user

Author: marmstr93ng

README.md

@@ -10,7 +10,9 @@ An application to manipulate postcode data.
 
 ## Build Exe
 
-- `pyinstaller --onefile src/postcode_parse/postcode_parse.py`
+- `pyinstaller --onefile src/postcode_parse/postcode_parse.py --clean`
+- Compile the `postcode_parser.iss` in Inno Setup Compiler
+- Run the installer (to install or to update)
 
 ## Launching
 

postcode_parser.iss

@@ -0,0 +1,51 @@
+; Script generated by the Inno Setup Script Wizard.
+; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!
+
+#define MyAppName "PostcodeParser"
+#define MyAppVersion "1.0"
+#define MyAppPublisher "Matthew Armstrong"
+#define MyAppExeName "postcode_parse.exe"
+
+[Setup]
+; NOTE: The value of AppId uniquely identifies this application. Do not use the same AppId value in installers for other applications.
+; (To generate a new GUID, click Tools | Generate GUID inside the IDE.)
+AppId={{78952356-F91F-41AE-B31C-AC505744949D}
+AppName={#MyAppName}
+AppVersion={#MyAppVersion}
+;AppVerName={#MyAppName} {#MyAppVersion}
+AppPublisher={#MyAppPublisher}
+DefaultDirName={autopf}\{#MyAppName}
+; "ArchitecturesAllowed=x64compatible" specifies that Setup cannot run
+; on anything but x64 and Windows 11 on Arm.
+ArchitecturesAllowed=x64compatible
+; "ArchitecturesInstallIn64BitMode=x64compatible" requests that the
+; install be done in "64-bit mode" on x64 or Windows 11 on Arm,
+; meaning it should use the native 64-bit Program Files directory and
+; the 64-bit view of the registry.
+ArchitecturesInstallIn64BitMode=x64compatible
+DisableProgramGroupPage=yes
+; Uncomment the following line to run in non administrative install mode (install for current user only.)
+;PrivilegesRequired=lowest
+PrivilegesRequiredOverridesAllowed=dialog
+OutputBaseFilename=PostcodeParser_Installer
+Compression=lzma
+SolidCompression=yes
+WizardStyle=modern
+
+[Languages]
+Name: "english"; MessagesFile: "compiler:Default.isl"
+
+[Tasks]
+Name: "desktopicon"; Description: "{cm:CreateDesktopIcon}"; GroupDescription: "{cm:AdditionalIcons}"; Flags: unchecked
+
+[Files]
+Source: "C:\Users\marms\Documents\Repos\PostcodeParse\dist\{#MyAppExeName}"; DestDir: "{app}"; Flags: ignoreversion
+; NOTE: Don't use "Flags: ignoreversion" on any shared system files
+
+[Icons]
+Name: "{autoprograms}\{#MyAppName}"; Filename: "{app}\{#MyAppExeName}"
+Name: "{autodesktop}\{#MyAppName}"; Filename: "{app}\{#MyAppExeName}"; Tasks: desktopicon
+
+[Run]
+Filename: "{app}\{#MyAppExeName}"; Description: "{cm:LaunchProgram,{#StringChange(MyAppName, '&', '&&')}}"; Flags: nowait postinstall skipifsilent
+

src/postcode_parse/_constants.py

@@ -3,13 +3,13 @@
 
 
 class SystemDefs:
-    LOG_DIRECTORY = "logging"
-    LOGGING_FILE_PATH = os.path.join(LOG_DIRECTORY, "log.log")
+    TEMP_FOLDER = os.getenv('TEMP')
+    TEMP_DIRECTORY = os.path.join(TEMP_FOLDER, "PostcodeParser")
+    LOGGING_FILE_PATH = os.path.join(TEMP_DIRECTORY, "log.log")
 
-    TEMP_DIRECTORY = ".tmp"
     TEMP_ONS_CSV = os.path.join(TEMP_DIRECTORY, "tmp_ons_data.csv")
 
-    OUTPUT_DIRECTORY = "output"
+    OUTPUT_DIRECTORY = os.path.join(TEMP_DIRECTORY, "output")
 
     PAF_FORMAT = {
         "Organisation Name": 11,

src/postcode_parse/postcode_parse.py

@@ -174,14 +174,6 @@ def kml_output(postcode_output_dict: Dict[str, PostcodeData], output_path: str)
     kml.save(output_path)
 
 
-def clean_tmp_folder(tmp_folder_path: str) -> None:
-    try:
-        shutil.rmtree(tmp_folder_path, ignore_errors=True)
-        logger.debug(f"Deleting the tmp directory at {tmp_folder_path} and all its contents")
-    except Exception as e:
-        logger.error(f"An error occurred while deleting the folder '{tmp_folder_path}': {e}")
-
-
 def guided_option_entry() -> Tuple[str, List[str], str, bool, bool, bool]:
     paf_path = questionary.path("What is the path to the PAF file?").ask()
 
@@ -199,8 +191,8 @@ def guided_option_entry() -> Tuple[str, List[str], str, bool, bool, bool]:
 
 
 if __name__ == "__main__":
-    atexit.register(clean_tmp_folder, SystemDefs.TEMP_DIRECTORY)
-    create_folder(SystemDefs.LOG_DIRECTORY)
+    atexit.register(input, "Press Enter to exit...")
+    create_folder(SystemDefs.TEMP_DIRECTORY)
     logger = create_logger(file_append=False)
 
     parser = argparse.ArgumentParser(description="Parse Postcodes")
@@ -224,3 +216,4 @@ def guided_option_entry() -> Tuple[str, List[str], str, bool, bool, bool]:
         options = (args.paf, args.districts, args.ons, args.csv_flag, args.kml_flag, args.disable_progress_bar)
 
     postcode_parse(*options)
+    os.startfile(SystemDefs.OUTPUT_DIRECTORY)