fix: log shouldn't be called before folder is created

chore: update pre-commit steps
chore: add icons to installer and exe
docs: added more detail on release steps

Author: Matthew Armstrong

.pre-commit-config.yaml

@@ -1,10 +1,17 @@
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  # Ruff version.
-  rev: v0.2.1
+  rev: v0.9.6
   hooks:
-    # Run the linter.
     - id: ruff
       args: [ --fix ]
-    # Run the formatter.
-    - id: ruff-format
+    - id: ruff-format
+
+- repo: local
+  hooks:
+    - id: compile_check
+      name: compile_check
+      language: python
+      entry: python -W error -m compileall src
+      types: [python]
+      stages: [pre-commit]
+      pass_filenames: false

README.md

@@ -7,10 +7,18 @@ An application to manipulate postcode data.
 - **Python 3**
 - **Python virtual environment** - Setup a folder called `.venv` with `python -m venv .venv` and activate with `.\\.venv\\Scripts\\activate`
 - **Dependencies** - Installed by running `pip install -e .[dev]` (remember to do so from inside a virtual environment)
+- **Setup Pre-commit hooks** - run `pre-commit install`
+
+## Create Release
+
+- Update version number
+  - `pyproject.toml`
+  - `postcode_parser.iss`
+  - `src/postcode_parse/_version.py`
 
 ## Build Exe
 
-- `pyinstaller --onefile src/postcode_parse/postcode_parse.py --clean`
+- `pyinstaller --onefile src/postcode_parse/postcode_parse.py --clean --icon=assets/postcode.ico --distpath=./`
 - Compile the `postcode_parser.iss` in Inno Setup Compiler
 - Run the installer (to install or to update)
 

assets/postcode.ico

@@ -2,7 +2,7 @@
 ; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!
 
 #define MyAppName "PostcodeParser"
-#define MyAppVersion "1.0"
+#define MyAppVersion "1.0.1"
 #define MyAppPublisher "Matthew Armstrong"
 #define MyAppExeName "postcode_parse.exe"
 
@@ -14,6 +14,7 @@ AppName={#MyAppName}
 AppVersion={#MyAppVersion}
 ;AppVerName={#MyAppName} {#MyAppVersion}
 AppPublisher={#MyAppPublisher}
+SetupIconFile=assets\postcode.ico
 DefaultDirName={autopf}\{#MyAppName}
 ; "ArchitecturesAllowed=x64compatible" specifies that Setup cannot run
 ; on anything but x64 and Windows 11 on Arm.
@@ -39,7 +40,7 @@ Name: "english"; MessagesFile: "compiler:Default.isl"
 Name: "desktopicon"; Description: "{cm:CreateDesktopIcon}"; GroupDescription: "{cm:AdditionalIcons}"; Flags: unchecked
 
 [Files]
-Source: "C:\Users\marms\Documents\Repos\PostcodeParse\dist\{#MyAppExeName}"; DestDir: "{app}"; Flags: ignoreversion
+Source: "{#MyAppExeName}"; DestDir: "{app}"; Flags: ignoreversion
 ; NOTE: Don't use "Flags: ignoreversion" on any shared system files
 
 [Icons]

assets/postcode.png

@@ -11,7 +11,7 @@ dependencies = [
 "questionary==2.0.1",
 "tqdm==4.64.1"
 ]
-version = "0.0.0"
+version = "1.0.1"
 
 [project.optional-dependencies]
 dev = [

postcode_parser.iss

@@ -0,0 +1 @@
+__version__ = "1.0.1"

pyproject.toml

@@ -3,7 +3,6 @@
 import csv
 import os
 import re
-import shutil
 from sys import exit
 from typing import Dict, Iterator, List, Tuple, Union
 
@@ -140,7 +139,7 @@ def retrieve_coords_ons(ons_data_path: str, postcode: str) -> Tuple[Union[str, N
 
 def create_folder(path: str) -> None:
     if not os.path.exists(path):
-        logger.debug(f"Creating folder at {path}")
+        # print(f"Creating folder at {path}")
         os.makedirs(path)