Python MSI Package Creation

in

Now, if you’re like me, the thought of creating a Windows installer from scratch might make your eyes glaze over faster than a cat staring at a laser pointer. But no need to get all worked up, bro, because with just a few lines of code and some basic knowledge of Python, we can create an MSI package that will have you dancing in the streets!

To begin with: let’s install the necessary packages for creating our MSI package using pip (the package manager for Python). Open up your terminal or command prompt and type:

# Install necessary packages for creating MSI package using pip
# msiexec_wrapper: a wrapper for the Windows Installer API
# pyinstaller: a package for converting Python scripts into standalone executables
pip install msiexec_wrapper pyinstaller

This will download and install two packages that we’ll be using to create our MSI package. The first is `msiexec_wrapper`, which allows us to execute MSIs from Python, and the second is `pyinstaller`, a popular tool for creating executable files from Python scripts.

Now let’s say you have a Python script called “myscript.py” that you want to turn into an MSI package. First, open up your favorite text editor or IDE (Integrated Development Environment) and create a new file called `create_msi.py`. In this file, we’ll be using the `os` module to execute our Python script with pyinstaller, and then running it through msiexec_wrapper to create an MSI package.

Here’s what your code might look like:

# Import necessary modules
import os
from msiexec_wrapper import MSIPackage

# Set the path to your Python script
script = "C:\\path\\to\\myscript.py"

# Define the MSI package properties
package_name = "My Awesome Script Installer"
author = "Your Name"
version = "1.0"
description = "This is a description of your Python script."
updates_url = "" # Leave blank if you don't have updates available
uninstall_string = "MSIEXEC /X{PRODUCTCODE}" # This will uninstall the MSI package when it's no longer needed.
product_code = "{GUID}" # Generate a GUID using this tool: https://www.guidgenerator.com/

# Create an instance of MSIPackage and set its properties
package = MSIPackage() # Create an instance of the MSIPackage class
package.setProductName(package_name) # Set the name of the MSI package
package.setAuthor(author) # Set the author of the MSI package
package.setVersion(version) # Set the version of the MSI package
package.setDescription(description) # Set the description of the MSI package
package.setUpdatesUrl(updates_url) # Set the updates URL for the MSI package
package.setUninstallString(uninstall_string) # Set the uninstall string for the MSI package
package.setProductCode(product_code) # Set the product code for the MSI package

# Add the Python script to the MSI package
package.addScript("C:\\path\\to\\myscript.py") # Add the specified script to the MSI package

# Execute pyinstaller and create an MSI package using msiexec_wrapper
os.system(f"pyinstaller --onefile {script} && msiexec /i {package.getPackagePath()}") # Use pyinstaller to create a single executable file for the specified script, then use msiexec to create an MSI package using the MSIPackage instance's getPackagePath() method.

In this code, we’re setting the properties of our MSI package (name, author, version, description, updates URL, and uninstall string), adding our Python script to it using `addScript`, and then executing pyinstaller with the `–onefile` flag to create an executable file. We’re also running msiexec_wrapper to create the MSI package itself.

Now all you have to do is save your code, open up a terminal or command prompt in the directory where your Python script and this new `create_msi.py` file are located, and run:

#!/bin/bash
# This is a bash script used to create an MSI package for a Python script.
# It utilizes the `--onefile` flag to create an executable file and runs msiexec_wrapper to create the MSI package itself.

# First, we need to check if the `create_msi.py` file exists in the current directory.
if [ -f "create_msi.py" ]; then
    # If it exists, we can proceed with creating the MSI package.
    # We use the `python` command to run the `create_msi.py` file.
    python create_msi.py
else
    # If the `create_msi.py` file does not exist, we display an error message.
    echo "Error: 'create_msi.py' file not found."
    # We also exit the script with a non-zero exit code to indicate failure.
    exit 1
fi

# To run this script, simply save your code and open a terminal or command prompt in the same directory.
# Then, execute the script using the following command:
# bash create_msi.sh

Your MSI package will be created automatically. You can then distribute it to your users or colleagues as needed.

Now that you’ve learned how to create an MSI package using Python, go out there and make some awesome installers for all of your Python scripts! And if you have any questions or comments, feel free to leave them below.

SICORPS