Creating Self-Contained Executables with PyInstaller

The primary objective when using PyInstaller is to generate standalone executables that can run on any machine without requiring Python installations or additional dependencies. This guide demonstrates the process of packaging entire applications including all necessary files and third-party libraries.

Basic Packaging Command

pyinstaller --onefile .\project\main.py --hidden-import "tkinter" --hidden-import=glob --hidden-import=lxml --add-data ".\project\*;." --distpath release_folder --add-data c:\tools\helper.exe;.

Command Breakdown

• --onefile: Creates a single executable file named main.exe using main.py as the entry point
• --hidden-import: Explicitly includes required libraries that might not be automatically detected
• --add-data ".\project\*;.": Includes all files from the project directory in the root of the executable
• --distpath release_folder: Specifies the output directory for the generated executable

Challenge 1: Handling Script Execution Within Packaged Applications

When your Python code uses sys.executable to invoke other Python scripts, issues arise because:

• In a normal Python environment, sys.executable points to the Python interpreter
• In a packaged application, sys.executable points to the executable itself

This causes the application to attempt running scripts using the executable, leading to errors.

Solution:

1. Package the called script as a separate executable (helper.exe)
2. Modify the calling script to use the absolute path to helper.exe instead of sys.executable

Challenge 2: Ensuring Portability Across Different Systems

When moving the application to another system, the helper.exe file must be present at the expected location, which violates our goal of having a single executable file.

Solution: Implement a resource path resolution function:

import os
import sys

def get_resource_path(relative_path):
    """Get absolute path to resource, works for development and for PyInstaller"""
    if hasattr(sys, '_MEIPASS'):
        # PyInstaller creates a temporary folder and stores path in _MEIPASS
        return os.path.join(sys._MEIPASS, relative_path)
    return os.path.join(os.path.abspath("."), relative_path)

The sys._MEIPASS attribute only exists when running a packaged executable. It contains the path to the temporary directory where PyInstaller extracts all necessary files. This function allows you to correctly locate resources whether running in development or packaged mode.

When using this function, replace hardcoded paths with get_resource_path("filename.ext") to ensure your application works correctly in both environments.