dist.py

#!/usr/bin/env python

# Install pyenv and configure the latest version globally before running this script.

import os
import sys
import argparse
import glob
from pathlib import Path

# Error and exit on Python version < 3.11
if sys.version_info < (3, 11):
    print("Python 3.11 or higher is required")
    sys.exit(1)

parser = argparse.ArgumentParser(description="Build nexus")
parser.add_argument('-n', "--no-build", action="store_true", help="Skip building the executable, only setup")
parser.add_argument('-d', "--devel", action="store_true", help="Install module locally and git hooks")
parser.add_argument('-u', "--ui-only", action="store_true", help="Only convert ui-related files"
                                                                 "(you must first have set up a venv and installed the"
                                                                 "requirements to run this)")
parser.add_argument("--no-venv", action="store_true", help="Don't use a virtual environment")
parser.add_argument("--venv-path", type=str, help="[Relative] path to virtual environment to use")
args = parser.parse_args()


def run_command(command: str):
    ret: int = os.system(command)
    if ret != os.EX_OK:
        sys.exit(ret)


# Get OS
os_name = "notwin"
venv_path = "" if args.no_venv else f"{args.venv_path if args.venv_path else 'venv'}/bin/"
python_name = venv_path + "python"
if sys.platform.startswith("win"):
    os_name = "win"
    venv_path = "venv\\Scripts\\"
    python_name = venv_path + "python.exe"
elif sys.platform.startswith("darwin"):
    os_name = "darwin"
print(f"OS detected as {os_name}")

if not args.ui_only:
    # Create virtual environment if it doesn't exist
    if args.no_venv:
        print("Skipping virtual environment setup")
    elif not os.path.isdir("venv"):
        print("Existing virtual environment not found, creating new one...")
        run_command("python3 -m venv venv")
    else:
        print("Found existing virtual environment")

    # Install requirements
    print("Installing requirements...")
    run_command(f"{python_name} -m pip install --upgrade pip -r requirements.txt")

# Convert ui files to python
print("Converting ui files to python...")
for f in glob.glob('ui/*.ui'):
    run_command(f"{venv_path}pyside6-uic {f} -o nexus/ui/{Path(f).stem}.py")

# Generate resources
print("Generating resources...")
run_command(f"{venv_path}pyside6-rcc ui/resources.qrc -o resources_rc.py")

# Generate translations
print("Generating TS templates...")
run_command(f"{venv_path}pyside6-lupdate " +
            ' '.join(glob.glob('ui/*.ui') + ["nexus/GUI.py"]) +
            " -ts translations/i18n_en.ts")
print("Generating QM files...")
os.makedirs('nexus/translations', exist_ok=True)
for f in glob.glob('translations/*.ts'):
    run_command(f"{venv_path}pyside6-lrelease {f} -qm nexus/translations/{Path(f).stem}.qm")

if not (args.no_build or args.ui_only):
    # Pyinstaller command
    build_cmd = "pyinstaller --onefile --name nexus nexus/__main__.py --icon ui/images/icon.ico --collect-all vinput"

    if os_name == "win":
        print("Building windowed executable...")
        run_command(f"{venv_path}{build_cmd} --windowed")
        run_command("move dist\\nexus.exe dist\\nexusw.exe")

    # Build executable
    print(f"Building {'console' if os_name == 'win' else ''} executable...")
    run_command(f"{venv_path}{build_cmd}")

    # Rename darwin executable
    if os_name == "darwin":
        os.rename("dist/nexus", "dist/nexus-macos")

    # Copy README and LICENSE to dist
    if os_name == "win":
        run_command("copy README.md dist")
        run_command("copy LICENSE dist")
    else:
        run_command("cp README.md LICENSE dist")

if args.devel:
    # Install dev/test requirements
    print("Installing dev/test requirements...")
    run_command(f"{python_name} -m pip install --upgrade pip -r test-requirements.txt")

    # Setup git hooks
    print("Setting up git hooks...")
    run_command(f"{venv_path}pre-commit install")

    # Install module locally
    print("Installing module locally...")
    run_command(f"{python_name} -m pip install -e .")

print(f"Done!{' Built executable is in dist/' if not (args.no_build or args.ui_only) else ''}")