Refactor setup.py: rename file, streamline version retrieval, and enhance output instructions

This is to skip the deprecation issues of `python setup.py` running rawly
Updated the README.md docs

Author: DefinetlyNotAI

README.md

@@ -12,11 +12,14 @@
 > * **Manual installation:**
 >
 >   1. Clone the repository and build the DLLs yourself.
->   2. Run the following to create the wheel file:
+>   2. Update the `VERSION` variable in `pyCTools/__init__.py` to match your desired version for the build.
+>   3. Run the following to create the wheel file:
 >      ```bash
->      cd tools python setup.py bdist_wheel
+>      pip install build
+>      cd tool
+>      python setupHelper.py  # Do not run `setup.py` directly, use this script instead as it handles many important things
 >      ```
->   3. The setup script will show you how to install the package locally with pip and how to create a virtual environment for testing.
+>   4. The setup script will show you how to install the package locally with pip and how to create a virtual environment for testing.
 > * **Automatic installation:**
 >   Go to the [releases page](https://github.com/DefinetlyNotAI/PyCTools/releases) and select the version you wish to install, and click on it, then copy the top `pip` command that will allow you to install it
 >   [Auto installation support from v0.2.0-beta and above]
@@ -69,7 +72,8 @@ This project provides a cross-language toolkit for Windows process inspection an
     │   ├── __init__.py                    # Package initializer
     │   ├── hwrng.py                       # Hardware RNG DLL wrapper
     │   ├── processInspect.py              # Process inspection DLL wrapper
-    │   └── _loadDLL.py                    # DLL loading logic used by wrappers
+    │   ├── _loadDLL.py                    # DLL loading logic used by wrappers
+    │   └── setup.py                       # Setup script for building and installing the package
     │
     ├── tool/                              # Build and distribution tools
     │   ├── compilerHelper.ps1             # Compiles C code into DLLs

pyCTools/__init__.py

@@ -2,5 +2,8 @@
 from pyCTools.processInspect import ProcessMetrics
 
 import os
+
 if os.name != 'nt':
     raise OSError('This package only supports Windows OS.')
+
+VERSION = "0.2.0-beta"

setup.py

@@ -0,0 +1,118 @@
+import os
+import pathlib
+import re
+import sys
+
+try:
+    # noinspection PyUnusedImports
+    from setuptools.command.bdist_wheel import bdist_wheel as _bdist_wheel
+    # noinspection PyUnusedImports
+    from setuptools import setup, find_packages
+    import wheel
+except ImportError:
+    sys.exit(
+        f"[x] Missing required dependencies (either wheel or setuptools)\n"
+        "        Suggested action: Run 'compilerHelper.ps1' to generate the DLLs before building."
+    )
+
+
+def check_bin_exists(bin_path: str):
+    try:
+        # Check that bin exists and has x86 & x64 DLLs
+        if not os.path.isdir(bin_path):
+            sys.exit(
+                "[x] 'pyCTools/bin/' folder not found.\n"
+                "        Suggested action: Run 'compilerHelper.ps1' to generate the DLLs before building.\n"
+            )
+
+        # Check subfolders and DLL presence
+        for arch in ("x86", "x64"):
+            arch_path = os.path.join(bin_path, arch)
+            if not os.path.isdir(arch_path) or not any(f.lower().endswith(".dll") for f in os.listdir(arch_path)):
+                sys.exit(
+                    f"[x] Missing DLLs in pyCTools/bin/{arch}/\n"
+                    "        Suggested action: Run 'compilerHelper.ps1' to generate the DLLs before building.\n"
+                )
+    except Exception as err:
+        sys.exit(f"[x] Fatal error while checking files exist and are ready: {err}")
+
+
+def output_dir_init() -> pathlib.Path:
+    try:
+        # Ensure ../dist/libraryWheel/ exists
+        output_dir = pathlib.Path(__file__).parent.parent / "dist" / "libraryWheel"
+        output_dir.mkdir(parents=True, exist_ok=True)
+
+        return output_dir
+    except Exception as err:
+        sys.exit(
+            f"[x] Failed to create output directory: {err}\n"
+            "        Suggested action: Ensure you have write permissions in the parent directory.\n"
+        )
+
+
+def print_separator(title: str = None) -> None:
+    """Print a separator with an optional title."""
+    print("\n" + "=" * 80)
+    if title:
+        print(title)
+        print("=" * 80)
+
+
+def get_version() -> str:
+    try:
+        here = os.path.abspath(os.path.dirname(__file__))
+        init_path = os.path.join(here, "pyCTools", "__init__.py")
+        version_regex = r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]'
+
+        with open(init_path, "r", encoding="utf-8") as f:
+            content = f.read()
+        match = re.search(version_regex, content, re.MULTILINE)
+        if match:
+            return match.group(1)
+        else:
+            sys.exit("[x] Could not find VERSION string in pyCTools/__init__.py")
+    except Exception as err:
+        sys.exit(f"[x] Error reading version from __init__.py: {err}\n")
+
+
+if __name__ == "__main__":
+    # Begin
+    print_separator("SETUP SCRIPT OUTPUT")
+
+    # Get the version from the __init__.py file - manually read
+    VERSION = get_version()
+    # Check if the bin directory exists and contains the required DLLs
+    check_bin_exists(bin_path=os.path.join("pyCTools", "bin"))
+
+    try:
+        o_dir = output_dir_init()
+
+        print("\033[90m")
+        setup(
+            name="pyCTools",
+            version=VERSION,
+            packages=find_packages() + ["pyCTools.bin.x64", "pyCTools.bin.x86"],
+            include_package_data=True,
+            package_data={
+                "pyCTools": ["bin/x86/*.dll", "bin/x64/*.dll"],
+            },
+            description="Your pyCTools package with bundled DLLs",
+            author="Shahm Najeeb",
+            author_email="[email protected]",
+            url="https://github.com/DefinetlyNotAI/PyCTools",
+            classifiers=[
+                "Programming Language :: Python :: 3",
+                "Operating System :: Microsoft :: Windows",
+            ],
+            options={
+                "bdist_wheel": {"dist_dir": str(o_dir)},
+                "sdist": {"dist_dir": str(o_dir)},
+            },
+        )
+        print("\033[0m")
+
+    except Exception as e:
+        sys.exit(f"\033[0m[x] An error occurred during setup: {e}\n")
+
+    print_separator()