build_windows_exe.py

# build_windows_exe.py
#
# Builds a Windows exe of brigadier using PyInstaller. PyInstaller
# will be downloaded to the cwd and its archive kept for later use.
#
# Requires:
# - Python 2.7 for Windows (http://www.python.org/getit)
# - pywin32 (http://sourceforge.net/projects/pywin32)
#
# Note (2022-11-07): This script needs to be overhauled to instead
# just use a virtualenv. PyInstaller 3.6 needs pywin32-ctypes, and
# also to pass a .spec file into pyinstaller, so that the exe contains
# more metadata and version info. As-is the script doesn't currently
# work, and I've just bumped the PyInstaller version to 3.6 as a reminder
# that this is the last version that is still compatible with Python 2.7.

import urllib
import os
from zipfile import ZipFile, BadZipfile
import subprocess
import shutil
import hashlib

PYINSTALLER_URL = 'https://github.com/pyinstaller/pyinstaller/archive/refs/tags/v3.6.zip'
PYINST_ZIPFILE = os.path.join(os.getcwd(), 'pyinstaller.zip')
NAME = 'brigadier'

with open('VERSION', 'r') as fd:
    version = fd.read().strip()
name_versioned = NAME + '-' + version
exe_name = NAME + '.exe'
pack_dir = os.path.join(os.getcwd(), name_versioned)
build_dir = os.path.join(os.getcwd(), 'build')

need_pyinstaller = False
if os.path.exists(PYINST_ZIPFILE):
    print "PyInstaller zipfile found."
    try:
        ZipFile(PYINST_ZIPFILE)
    except BadZipfile:
        print "Zipfile is corrupt."
        need_pyinstaller = True
else:
    need_pyinstaller = True

if need_pyinstaller:
    print "Downloading PyInstaller..."
    urllib.urlretrieve(PYINSTALLER_URL, filename=PYINST_ZIPFILE)

dlzip = ZipFile(PYINST_ZIPFILE)
pyinst_root = dlzip.namelist()[0].split("/")[0]
dlzip.extractall()

print "Building version %s..." % version
build_cmd = [os.path.join(os.environ["SYSTEMDRIVE"] + "\\", 'Python27', 'python.exe'),
             os.path.join(os.getcwd(), pyinst_root, 'pyinstaller.py'),
             '-F',
             '--distpath', pack_dir,
             '--name', NAME,
             'brigadier']
subprocess.call(build_cmd)

print "Compressing to zip file..."
zipfile_name = name_versioned + '.zip'
packzip = ZipFile(zipfile_name, 'w')
packzip.write(os.path.basename(pack_dir))
packzip.write(os.path.join(os.path.basename(pack_dir), exe_name))
packzip.close()
with open(zipfile_name, 'r') as zipfd:
    sha1 = hashlib.sha1(zipfd.read()).hexdigest()

print "Cleaning up..."
for dirs in [pack_dir, build_dir, pyinst_root]:
    shutil.rmtree(dirs)
for f in os.listdir(os.getcwd()):
    if f.startswith('logdict'):
        os.remove(f)

print "Built and archived to %s." % zipfile_name
print "SHA1: %s" % sha1