cnapy-installers-creator.py

import subprocess
import os
import sys
import urllib.request
import shutil
from tkinter import messagebox
from tkinter import filedialog
from zipfile import ZipFile, ZIP_LZMA

# If you just want to update the CNApy version, you just have to edit the following string
# and run the CNApy installers creator:
CNAPY_VERSION = "1.2.1"
# Here, select your wished miniforge installer .exe
# as described in https://github.com/conda-forge/miniforge
miniforge_EXE_URL = "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Windows-x86_64.exe" # "https://repo.anaconda.com/miniforge/miniforge3-latest-Windows-x86_64.exe"

# Start the actual GUI program
answer = messagebox.askyesno(
    "Welcome to the CNApy installers creator!",
    f"This program will create the installers for CNApy version {CNAPY_VERSION}.\n"
    "Do you want to proceed?"
)
if not answer:
    sys.exit(0)

messagebox.showinfo(
    "Choose the CNApy installers folder",
    "In the next step, choose an folder (e.g., a newly created folder) on your computer "
    "where you want the CNApy installers to be created."
)

selected_folder = filedialog.askdirectory(
    title="Choose CNApy installation folder",
    initialdir="C:\\Program Files",
)
selected_folder = selected_folder.replace("/", "\\")
if not selected_folder.endswith("\\"):
    selected_folder += "\\"

if (selected_folder == "") or (not os.path.isdir(selected_folder)):
    messagebox.showerror(
        "No valid folder selected",
        "It appears that you didn't select a valid installation folder.\n"
        "Please try the CNApy installers installation process again in a different folder "
        "and without clicking on 'Cancel'."
    )
    sys.exit(0)
if len(os.listdir(selected_folder)) > 0:
    new_folder_name = "CNApy_Installers"
    if os.path.exists(f"{selected_folder}{new_folder_name}"):
        counter = 2
        while os.path.exists(f"{selected_folder}{new_folder_name}"):
            new_folder_name = f"CNApy_Installers{counter}"
            counter += 1
    selected_folder += new_folder_name + "\\"

    answer = messagebox.askyesno(
        "Confirm folder for CNApy installers",
        "Your selected folder is not empty. Since the CNApy installers need to be installed in an empty folder,"
        f"the new empty subfolder {selected_folder} will be created and, therefore, the installers will be "
        "installed in the following full folder path:\n"
        f"{selected_folder}\n"
        f"Are you ok with this procedure?"
    )
    if not answer:
        messagebox.showerror(
            "Error in folder selection",
            "Please retry the installation with a different folder."
        )
        sys.exit(0)
    try:
        os.mkdir(selected_folder)
    except Exception:
        messagebox.showerror(
            "Error with folder creation",
            "The new empty folder could not be created. Please make sure that you are allowed to have "
            "access to your provided installation folder. E.g., this might be the case in the folder 'Programs' or 'Program Files'. "
            "If this error persists, please retry the installation "
            "in a different folder, e.g. in a new empty folder that you created."
        )
        sys.exit(0)

answer = messagebox.askyesno(
    "Choosing folder successful",
    "Now, the installers are going to be installed. This may take a while.\n"
    "Please be patient until a new message appears.\n"
    "Do you want to proceed with the CNApy installers creation?"
)
if not answer:
    sys.exit(0)

miniforge_exe_name = "miniforge.exe"
miniforge_exe_path = f"{selected_folder}{miniforge_exe_name}"
try:
    urllib.request.urlretrieve(miniforge_EXE_URL, miniforge_exe_path)
except Exception:
    messagebox.showerror(
        "Error while downloading",
        "An error occurred in a download process of the installation.\n"
        "Please make sure that your internet connection works and retry the installation."
    )
    sys.exit(0)

miniforge_install_path = f"{selected_folder}\\CNApy\\miniforge\\"
if os.path.exists(miniforge_install_path):
    messagebox.showerror(
        "The installers seem to be already downloaded in this folder",
        "It looks like the installers were already downloaded in the given folder.\n"
        "Please install the installers in a new folder.\n"
    )
    sys.exit(0)

# As per https://stackoverflow.com/questions/39984611/
miniforge_command =  f'cd "{selected_folder}" && {miniforge_exe_name} /S /InstallationType=JustMe /AddToPath=0 /RegisterPython=0 /NoRegistry=1 /D={miniforge_install_path}'

try:
    has_run_error = subprocess.check_call(
        miniforge_command,
        shell=True
    )  # The " are introduces in order to handle paths with blank spaces
except subprocess.CalledProcessError:
    has_run_error = True
if has_run_error:
    messagebox.showerror(
        "Error while running installation process",
        "Error during the execution of the installation process.\n"
        "Please make sure that you have full access permissions on the selected "
        "installation folder."
    )
    sys.exit(0)

mamba_path = f"{miniforge_install_path}\\condabin\\mamba"
clean_command = f'"{mamba_path} clean -a --yes'

os.system(clean_command)
os.remove(miniforge_exe_path)

os.mkdir(f"{selected_folder}\\CNApy\\icon")
shutil.copy("./app.ico", f"{selected_folder}\\CNApy\\icon\\CNApy_icon.ico")

with open(f"{selected_folder}\\CNApy\\INSTALL_CNAPY.bat", "w") as f:
    f.write(
        f"""
@echo off
setlocal

REM Get the user's desktop path using USERPROFILE environment variable
set "desktopPath=%USERPROFILE%\Desktop"


REM Create the new batch file in the current folder
(
echo @echo off
echo echo "Starting CNApy {CNAPY_VERSION} (this may take some time)..."
echo miniforge\\condabin\\conda activate cnapy-{CNAPY_VERSION} ^& cnapy
) > "%~dp0RUN_CNApy.bat"


REM Create the new batch file in the current folder
(
echo @echo off
echo echo "Uninstalling CNApy {CNAPY_VERSION} (this may take some time)..."
echo miniforge\\Uninstall-Miniforge3.exe
) > "%~dp0UNINSTALL_CNAPY.bat"

REM Create desktop icon
@echo off
set SCRIPT_PATH=%~dp0RUN_CNApy.bat
set ICON_PATH=%~dp0icon\\CNApy_Icon.ico
set SHORTCUT_PATH=%USERPROFILE%\\Desktop\\CNApy-{CNAPY_VERSION}.lnk
set WORKING_DIR=%~dp0

(
echo Set oWS = WScript.CreateObject^("WScript.Shell"^)
echo sLinkFile = "%SHORTCUT_PATH%"
echo Set oLink = oWS.CreateShortcut^(sLinkFile^)
echo oLink.TargetPath = "%SCRIPT_PATH%"
echo oLink.IconLocation = "%ICON_PATH%"
echo oLink.WorkingDirectory = "%WORKING_DIR%"
echo oLink.Save
) > CreateShortcut.vbs

cscript //nologo CreateShortcut.vbs
del CreateShortcut.vbs

./miniforge/condabin/mamba create -n cnapy-{CNAPY_VERSION} -c Gurobi -c IBMDecisionOptimization -c conda-forge -c cnapy cnapy={CNAPY_VERSION} --yes

endlocal
    	"""
    )

with open(f"{selected_folder}\\cnapy-assistant-script.sh", "w") as f:
    f.write(
        "#!/bin/sh\n"
        f"./conda create -n cnapy-{CNAPY_VERSION} -c Gurobi -c IBMDecisionOptimization -c conda-forge -c cnapy cnapy={CNAPY_VERSION} --yes"
    )

messagebox.showinfo(
    "Successful installers generation",
    f"The installers were succesfully generated in {selected_folder}."
    "Remaining step: put the Windows installer (the .bat file and the CNApy subfolder) into a .zip file."
)