- v0.1.0 pre-release commit.

- Completed README.md.
- New relevant screenshot in README.md.
- Fixed bug causing incorrect results to display upon completion of option 1.
- Attempt to fix "relative import" error in "setup_loggers.py" by moving log configuration/declaration back to `main.py` as new method.

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

Author: schlopp96

README.md

@@ -1,17 +1,98 @@
 # UpgradePipPkgs
 
-- This is a small powershell script that will allow the user to upgrade _all_ outdated global pip packages at once.
+> Tool for upgrading all global `pip` packages with one command.
 
 ---
 
-## Full Repo Coming Soon
+## About
+
+- **_`UpgradePipPkgs`_** can upgrade all of your `pip` packages using one of two methods:
+
+  **Method 1:**
+
+  > **First gather all outdated packages using the command `pip list --outdated`, then pass results to a list of outdated packages to be upgraded.**
+
+  - This method is generally more efficient than the following method, as only outdated packages are passed to upgrade process.
+  - Unfortunately doesn't take into account package dependencies relying on specific package versions to function properly.
+
+  ---
+
+  **Method 2:**
+
+  > **Iterate over _all_ installed packages, passing the command `pip install --upgrade {pkgname}` over each one.**
+
+  - This method takes more time overall, but is "safer".
+  - "Safer" in this context meaning that package dependencies are corrected upon attempting upgrade on a package that specifies its dependencies, downgrading specific package versions where necessary.
+  - Note that not all packages will be able to downgrade, as the order of packages upgraded is relevant to whether incorrect version dependencies are corrected.
+    - For example, let's assume **`PackA`** requires **`PackB<=1.0.0`** as a dependency:
+      1. **`PackA`** will be checked for available upgrade first, and will check for installed dependency pkg **`PackB<=1.0.0`**, installing it if not already installed.
+      2. `PackB` is then checked, and has a new version available, `1.1.0`.
+      3. `PackB-1.0.0` is then upgraded to `1.1.0`, but now `PackA` can't function correctly due to incorrect dependency version.
+      4. This can easily be fixed by reinstalling `PackA` using the `pip` install command: "`pip install PackA`".
+
+- You can review past results/program output in the application's log file, which can be found here:
+  - `"~/UpgradePipPkgs/logs/output.log"`
+
+---
+
+## Installation
+
+### Using PIP _(Recommended)_
+
+> _Easiest_ method. Highly recommended over manual installation.
+
+- To install _**`UpgradePipPkgs`**_ using `pip`, enter the following in your commandline environment:
+
+  ```python
+  > pip install UpgradePipPkgs
+  ```
+
+- You should now be able to import/run _**`UpgradePipPkgs`**_ within your python environment by entering the following:
+
+  ```python
+  >>> from UpgradePipPkgs import upgrade_pip_pkgs
+  ...
+  ```
+
+- Done!
+
+---
+
+### Manual Installation
+
+> _Not_ recommended.
+
+1. Before use, navigate to intended installation location, and create a new directory.
+2. Install all dependencies for this package within said directory using:
+
+   ```python
+     pip install -r requirements.txt
+   ```
+
+3. Clone repository with the git client of your preference.
+   - (Optional) move installation directory to `"path/to/Python/Libs/site_packages"` to be able to import this package to a Python program like any other importable package.
+
+- Done!
+
+---
+
+## Usage
+
+- In order to use _**`UpgradePipPkgs`**_, start by importing the module to your Python environment:
+
+  ```python
+  >>> from UpgradePipPkgs import upgrade_pip_pkgs
+  ```
+
+- Call the `upgrade_pip_pkgs` function to start the application, and choose the method of operation by typing the option number, and press **[ENTER]**.
+
+![alt](./img/README_screenshot.png)
 
 ---
 
-Contact
+## Contact the Author
 
-- Send me an email with any questions, concerns, comments, etc. to `schloppdaddy@gmail.com`
-- Project GitHub [repository](https://github.com/schlopp96/TotalPipUpgrade).
-- My GitHub [profile](https://github.com/schlopp96/)
+- If you have any questions, comments, or concerns that cannot be alleviated through the [project's GitHub repository "issues" tab](https://github.com/schlopp96/UpgradePipPkgs), please feel free to contact me through my email address:
+  - `schloppdaddy@gmail.com`
 
 ---

UpgradePipPkgs/main.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 
+import logging
 import subprocess
 import sys
 from os import chdir
@@ -8,21 +9,61 @@
 
 from PyLoadBar import load
 
-from setup_loggers import mainLogger, processLogger
+
 
 chdir(dirname(__file__))
 
 __version__ = '0.1.0'
 
 textborder: str = f'\n<{"*" * 120}>\n'
 
+def config_logs(__file__) -> tuple[logging.Logger, logging.Logger]:
+    """Set program logging configuration and generate loggers.
+
+---
+
+    Parameters:
+        :param __file__: file to be logged.
+        :type __file__: Any
+        :return: program logging configuration.
+        :rtype: tuple[Logger, Logger]
+    """
+    # Log activity from file.
+    mainLogger = logging.getLogger(__file__)
+    mainLogger.setLevel(logging.INFO)
+
+# Log activity from upgrade script `global_upgrade.ps1`.
+    processLogger = logging.getLogger('Subprocess')
+    processLogger.setLevel(logging.INFO)
+
+# Handler for pre/post upgrade subprocess.
+    mainFormatter = logging.Formatter(
+    '[{asctime} :: {levelname} :: Line: {lineno}] - {message}\n', style='{')
+    mainHandler = logging.FileHandler('./logs/output.log')
+    mainHandler.setFormatter(mainFormatter)
+
+# Handler for during upgrade subprocess
+    processFormatter = logging.Formatter(
+    '[{asctime} :: {levelname} :: {funcName}] - {message}\n', style='{')
+    processHandler = logging.FileHandler('./logs/output.log')
+    processHandler.setFormatter(processFormatter)
+
+# Add handlers to both loggers.
+    mainLogger.addHandler(mainHandler)
+    processLogger.addHandler(processHandler)
+
+    return mainLogger,processLogger
+
+# Set logger names.
+mainLogger, processLogger = config_logs(__file__)
+
 def get_outdated_pkgs():
     """Subprocess to retrieve outdated global pip packages using `pip list --outdated`.
 
     ---
 
     Parameters:
-        :return: retrieve and pass outdated global pip packages into a list for upgrading.
+        :return: retrieve and pass outdated global pip packages to a list to be upgraded.
         :rtype: (List[str] | None)
     """
     outdated_pkgs =[]
@@ -54,7 +95,6 @@ def upgrade_outdated(outdated_pkgs: list):
         :rtype: tuple[list, list] | None
     """
     processLogger.info('Upgrading outdated pip packages...')
-
     print('Upgrading outdated pip packages...\n')
 
     processLogger.info('No. Package            Version           Latest           Type  Status  ')
@@ -103,7 +143,7 @@ def upgrade_all():
     processLogger.info('Upgrading outdated pip packages using "brute force"...')
     print('Upgrading outdated pip packages using "brute force"...\n')
 
-    script_p = subprocess.Popen(['powershell.exe', './scripts/force_upgrade_pip_pkgs.ps1'], stdout=subprocess.PIPE, stderr = subprocess.STDOUT)
+    script_p = subprocess.Popen(['powershell.exe', './scripts/force_upgrade_pip_pkgs.ps1'], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
     with script_p.stdout:
         try:
             for line in iter(script_p.stdout.readline, b''):
@@ -160,13 +200,13 @@ def main() -> NoReturn | None:
                         upgradelist, errorlist  = upgrade_outdated(outdated_pkgs)
                         total=len(outdated_pkgs)
                         mainLogger.info('Successfully completed upgrade process!')
-                        mainLogger.info('\nSUMMARY:')
+                        mainLogger.info('SUMMARY:')
                         mainLogger.info(f'No. of packages upgraded = {len(upgradelist)}/{total}')
-                        mainLogger.info(f'No. of upgrade errors    = {len(upgradelist)}/{total}')
+                        mainLogger.info(f'No. of upgrade errors    = {len(errorlist)}/{total}')
                         print('\nSuccessfully completed upgrade process!')
                         print('\nSUMMARY:')
                         print(f'No. of packages upgraded = {len(upgradelist)}/{total}')
-                        print(f'No. of upgrade errors    = {len(upgradelist)}/{total}')
+                        print(f'No. of upgrade errors    = {len(errorlist)}/{total}')
                         input('\nPress Enter to Exit.')
                         return exitProgram(0)
                     else: