- Fixed logging issue causing multiple handlers to log at once.

- Updated requirements.
- Fixed issues due to new version of PyLoadBar.
- Added code in `main.py` to automatically add program to Python path upon run.
- Greatly expanded method documentation.
- Improved source code formatting across entire repo.
- Improved README content.
- Fixed several import bugs.

Signed-off-by: schlopp96 <71921821+schlopp96@users.noreply.github.com>

Author: schlopp96

README.md

@@ -6,26 +6,26 @@
 
 ## About
 
-- **V**alheim **B**epInEx **P**atcher is a CLI application for patching the Unity modding plugin, [_**BepInEx**_](https://github.com/BepInEx/BepInEx) to its latest release (whether LTS or experimental).
+- _**V**alheim **B**epInEx **P**atcher_ is a CLI application for patching the Unity modding plugin, [_**BepInEx**_](https://github.com/BepInEx/BepInEx) to its latest release (whether LTS or experimental).
 
-- **VBP** was originally created as a solution for an issue that occurs while using the [**_Vortex_**](https://) modding tool to mod the game **Valheim**, whilst having **BepInEx** installed.
+- _**VBPatcher**_ was originally created as a solution for an issue that occurs while using the [**_Vortex_**](https://) modding tool to mod the game _**Valheim**_, whilst having _**BepInEx**_ installed.
 
-  - When opening **Vortex** to begin modding Valheim, the modding tool automatically downloads what it _incorrectly_ perceives to be the "latest" version of **BepInEx** (a necessary requirement for the vast majority of mods available) which is generally incorrect, and often takes a long time to be fixed.
+  - When opening **_Vortex_** to begin modding **_Valheim_**, the modding tool automatically downloads what it _incorrectly_ perceives to be the "latest" version of _**BepInEx**_ (a necessary requirement for the vast majority of mods available) which is generally incorrect, and often takes a long time to be fixed.
 
-  - Unfortunately, this means if you were using an experimental/newer/different build of **BepInEx**, it has been overwritten by whatever build **Vortex** installed.
+  - Unfortunately, this means if you were using an experimental/newer/different build of _**BepInEx**_, it has been overwritten by whatever build _**Vortex**_ installed.
 
-  - This occurs _each and every time_ you open **Vortex**, and became a major annoyance for me, so I decided to create a quick solution to make this problem less annoying.
+  - This occurs _each and every time_ you open _**Vortex**_, and became a major annoyance for me, so I decided to create a quick solution to make this problem less annoying.
 
 ---
 
 ## Installation
 
 ### Using PIP _(Recommended)_
 
-- To install VBPatcher using `pip`, enter the following:
+- To install _**VBPatcher**_ using `pip`, enter the following:
 
   ```python
-  pip install VBPatcher
+    python -m pip install VBPatcher
   ```
 
 ### Manual Installation _(**NOT** Recommended)_
@@ -46,12 +46,12 @@
 
 1. Open the application, which can be run within a terminal using the following command:
 
-    ```psh
-      PS> vbpatcher
-    ```
+   ```psh
+    PS > vbpatcher
+   ```
 
-    - You can also run **VBP** from the main program file:
-      - `~/VBPatcher/main.py`.
+   - You can also run **VBP** from the main program file:
+     - `~/VBPatcher/main.py`.
 
 2. Once the script is run, you will be presented with an option menu, allowing you to choose whether to:
 
@@ -106,7 +106,7 @@
 - Within a terminal, open **VBP** with the following command:
 
   ```psh
-    PS> vbpatcher
+    PS > vbpatcher
   ```
 
 - Or optionally within a python environment:

VBPatcher/applogger/applogger.py

@@ -1,9 +1,28 @@
 import logging
 
+from VBPatcher.globalvars.globalvars import _logFile
+
+
 class _LogGenerator():
     """Wrapper for application logging.
 
     - Uses built-in Python `logging` module.
+
+    - Class methods:
+        - `debug(self, msg) -> None`
+            - Logs a message with level `DEBUG`.
+
+        - `info(self, msg) -> None`
+            - Logs a message with level `INFO`.
+
+        - `warning(self, msg) -> None`
+            - Logs a message with level `WARNING`.
+
+        - `error(self, msg) -> None`
+            - Logs a message with level `ERROR`.
+
+        - `critical(self, msg) -> None`
+            - Logs a message with level `CRITICAL`.
     """
 
     CRITICAL = 50
@@ -15,12 +34,12 @@ class _LogGenerator():
     DEBUG = 10
     NOTSET = 0
 
-    def __init__(
-            self,
-            log_file: str = __name__,
-            log_format: str = '[%(asctime)s - %(levelname)s] : %(message)s',
-            date_fmt: str = "%Y-%m-%d %H:%M:%S",
-            log_lvl=INFO):
+    def __init__(self,
+                 name: str,
+                 log_file: str,
+                 log_fmt: str = '[%(asctime)s - %(levelname)s] : %(message)s',
+                 date_fmt: str = "%Y-%m-%d %H:%M:%S",
+                 level=INFO):
         """Initialize logger instance.
 
         - For the `log_lvl` parameter, the level of logging can be any of the following:
@@ -35,37 +54,79 @@ def __init__(
 
         ---
 
-        :param log_file: assign specific name to logger, defaults to `__name__`.
-        :type log_file: str, optional
-        :param log_format: Initialize the formatter either with the specified format string, or a default as described above, defaults to '[%(asctime)s - %(levelname)s] : %(message)s'
-        :type log_format: str, optional
+        :param name: Name of logger.
+        :type name: str
+        :param log_file: file to create log entries.
+        :type log_file: str
+        :param log_fmt: Initialize the formatter either with the specified format string, or a default as described above, defaults to '[%(asctime)s - %(levelname)s] : %(message)s'
+        :type log_fmt: str, optional
         :param date_fmt: set date formatting, defaults to "%Y-%m-%d %H:%M:%S"
         :type date_fmt: str, optional
-        :param log_lvl: Set the logging level of this logger. Level must be an int or a str, defaults to `INFO`.
-        :type log_lvl: int, optional
+        :param level: Set the logging level of this logger. Level must be an int or a str, defaults to `INFO`.
+        :type level: int, optional
         """
-        self.logger = logging.getLogger(log_file)
-        self.log_format = log_format
+
+        self.name = name
+        self.logger = logging.getLogger(name)
+        self.log_format = log_fmt
         self.datefmt = date_fmt
-        self.log_lvl = log_lvl
-        self.formatter = logging.Formatter(log_format, datefmt=date_fmt)
+        self.log_lvl = level
+        self.formatter = logging.Formatter(log_fmt, datefmt=date_fmt)
         self.log_file = log_file
         self.fhandler = logging.FileHandler(log_file)
         self.logger.addHandler(self.fhandler)
         self.fhandler.setFormatter(self.formatter)
-        self.logger.setLevel(log_lvl)
+        self.logger.setLevel(level)
 
-    def debug(self, msg):
+    def debug(self, msg) -> None:
+        """Logs a message with level `DEBUG`.
+
+        :param msg: message to be logged.
+        :type msg: str
+        :return: creates log entry.
+        :rtype: None
+        """
         return self.logger.debug(msg)
 
     def info(self, msg):
+        """Logs a message with level `INFO`.
+
+        :param msg: message to be logged.
+        :type msg: str
+        :return: creates log entry.
+        :rtype: None
+        """
         return self.logger.info(msg)
 
     def warning(self, msg):
+        """Logs a message with level `WARNING`.
+
+        :param msg: message to be logged.
+        :type msg: str
+        :return: creates log entry.
+        :rtype: None
+        """
         return self.logger.warning(msg)
 
     def error(self, msg):
+        """Logs a message with level `ERROR`.
+
+        :param msg: message to be logged.
+        :type msg: str
+        :return: creates log entry.
+        :rtype: None
+        """
         return self.logger.error(msg)
 
     def critical(self, msg):
+        """Logs a message with level `CRITICAL`.
+
+        :param msg: message to be logged.
+        :type msg: str
+        :return: creates log entry.
+        :rtype: None
+        """
         return self.logger.critical(msg)
+
+
+logger = _LogGenerator(__name__, _logFile)

VBPatcher/downloader/downloader.py

@@ -4,29 +4,32 @@
 import sys
 from zipfile import ZipFile
 
-import VBPatcher.applogger.applogger
-import VBPatcher.globalvars.globalvars
 import requests
 import tqdm
+import VBPatcher.globalvars.globalvars
+from VBPatcher.applogger.applogger import logger
+
 
-logger = VBPatcher.applogger.applogger._LogGenerator(VBPatcher.globalvars.globalvars._logFile)
 class _Downloader:
     """Wrapper containing patch-file update functionality.
 
     - Class Methods:
         - `dl_stable(self, url) -> BufferedWriter`
             - Download latest BepInEx stable release.
+
         - `dl_dev(self, url) -> BufferedWriter`
             - Download latest BepInEx development build.
+
         - `unzip_patch(self, filename, stable) -> None`
             - Unzip downloaded patch files before deleting patch `.zip` archive.
+
         - `_UpdatePatcher(self) -> None`
             - Process to retrieve latest available patch files using class methods.
     """
     def __init__(self) -> None:
         pass
 
-    def dl_stable(self, url):
+    def _dl_stable(self, url):
         """Download zip containing latest BepInEx stable release.
 
         :return: zip archive containing patch files.
@@ -60,7 +63,7 @@ def dl_stable(self, url):
                         print('\nCancelled update-check.\n')
                         break
 
-    def dl_dev(self, url):
+    def _dl_dev(self, url):
         """Download zip archive containing latest BepInEx development build.
 
         :return: zip archive containing patch files.
@@ -94,7 +97,7 @@ def dl_dev(self, url):
                         break
 
     def _unzip_patch(self, filename, stable: bool) -> None:
-        """Unzip downloaded patch files before deleting patch `.zip` archive.
+        """Unzip downloaded patch files and cleanup leftover files.
 
         ---
 
@@ -108,12 +111,13 @@ def _unzip_patch(self, filename, stable: bool) -> None:
         logger.info('Unzipping patch files...')
         print('Unzipping patch files...')
         try:
-            if stable:
+            if stable: # Unzip stable release patch files
                 with ZipFile(filename) as archive:
                         archive.extractall(path='./patch-files/stable')
                 os.unlink('./patch-files/stable/doorstop_config.ini')
                 os.unlink(f'./patch-files/stable/BepInEx_stable_{VBPatcher.globalvars.globalvars.b_stable}.zip')
-            else:
+
+            else: # Unzip development build patch files
                 with ZipFile(filename) as archive:
                     archive.extractall(path='./patch-files/development')
                 os.unlink('./patch-files/development/doorstop_config.ini')
@@ -127,19 +131,22 @@ def _unzip_patch(self, filename, stable: bool) -> None:
             print(f'\nEncountered error while attempting to unzip archive...\n>> Exception: {err}\n')
 
     def _UpdatePatcher(self) -> None:
-        """Process to retrieve latest available patch files using class methods.
+        """Retrieve latest available patch files.
 
         ---
 
-        :return: most recent release/build patch files.
+        :return: download most recent release/build patch files.
         :rtype: None
         """
-        self.dl_stable(VBPatcher.globalvars.globalvars.url_stable)
+        # Retrieve stable release patch files
+        self._dl_stable(VBPatcher.globalvars.globalvars.url_stable)
         self._unzip_patch(f'./patch-files/stable/BepInEx_stable_{VBPatcher.globalvars.globalvars.b_stable}.zip', True)
-        self.dl_dev(VBPatcher.globalvars.globalvars.url_dev)
+
+        # Retrieve development build patch files
+        self._dl_dev(VBPatcher.globalvars.globalvars.url_dev)
         self._unzip_patch(f'./patch-files/development/BepInEx_dev_{VBPatcher.globalvars.globalvars.b_dev}.zip', False)
 
         logger.info('Completed Patcher Update!\n>> Patches ready for deployment!\n')
         print('\nCompleted Patcher Update!\n>> Patches ready for deployment!\n')
         print('Press anything to continue...')
-        m.getch()
+        m.getch() # Wait for user to press any key to continue

VBPatcher/globalvars/globalvars.py

@@ -1,6 +1,5 @@
 from datetime import datetime
 
-
 p_stable: str = r'.\patch-files\stable'
 url_stable = 'https://github.com/BepInEx/BepInEx/releases/download/v5.4.19/BepInEx_x64_5.4.19.0.zip'
 b_stable: str = url_stable[53:60]  #release version
@@ -15,4 +14,4 @@
 
 _datefmt: str = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
 
-_textborder: str = "=".ljust((61), "=")
+_textborder: str = "=".ljust((61), "=")

VBPatcher/main.py

@@ -1,27 +1,30 @@
 #!/usr/bin/env python3
 
+import sys
 from os import chdir
 from os.path import dirname
 from time import sleep
 from typing import NoReturn
 
-from PyLoadBar import load
+import PyLoadBar
 
+sys.path.insert(0, dirname(dirname(__file__))) # Ensure main module can be found by Python.
 chdir(dirname(__file__))
 
 import VBPatcher.globalvars.globalvars
-from VBPatcher.applogger.applogger import _LogGenerator
+from VBPatcher.applogger.applogger import logger
 from VBPatcher.downloader.downloader import _Downloader
 from VBPatcher.patching.patching import _Patcher
 from VBPatcher.subprocessing.subprocessing import _exitPatcher, _openValheim
 from VBPatcher.validation.validation import _Validate
 
 __version__: str = '0.6.0'
 
-logger = _LogGenerator(VBPatcher.globalvars.globalvars._logFile)
+
 DL = _Downloader()
 Patcher = _Patcher()
 Validations = _Validate()
+bar = PyLoadBar.PyLoadBar()
 
 #$ ====================================================================================================== $#
 
@@ -52,7 +55,7 @@ def main() -> None | NoReturn:
             case '5': _openValheim()
             case '6':
                 logger.info('BepInEx patching process cancelled...\n>> Preparing to exit...\n')
-                load('\nBepInEx patching process cancelled', 'Preparing to exit...', enable_display=False)
+                bar.load('\nBepInEx patching process cancelled', 'Preparing to exit...', enable_display=False)
                 return _exitPatcher()
             case _:
                 logger.warning(f'Invalid Input:\n>> "{choosePatch}"\n\n>> Must ONLY enter:\n>> [1] for stable release {VBPatcher.globalvars.globalvars.b_stable}\n>> [2] for development build {VBPatcher.globalvars.globalvars.b_dev}\n>> [3] for FULL upgrade (apply both patches in order of release)\n>> [4] to update available patch versions/builds\n>> [5] to open Valheim\n>> [6] to exit program\n')