PyInstaller API Manual

Guide

• Requirements
• License
• How To Contribute
• Installing PyInstaller
• Installing Using pip
• Installing in Windows
• Installing from the archive
• Verifying the installation
• Installed commands
• Overview: What PyInstaller Does and How It Does It
• Analysis: Finding the Files Your Program Needs
• Bundling to One Folder
• Bundling to One File
• How the One-Folder Program Works
• How the One-File Program Works
• Console or not?
• Hiding the Source Code
• Using PyInstaller
• Options
• General Options
• Options for Finding Imported Modules and Libraries
• Options for the Executable Output
• Options for Windows apps
• Options for Mac OS X apps
• Building Mac OS X App Bundles
• Setting a Custom Icon
• Setting the Supported Document Types
• Getting the Opened Document Names
• Shortening the Command
• Using UPX
• Supporting Multiple Platforms
• Supporting Multiple Python Environments
• Supporting Multiple Operating Systems
• Using Spec Files
• Spec File Operation
• TOC Class (Table of Contents)
• The Tree Class
• Adding Files to the Bundle
• Giving Run-time Python Options
• When Things Go Wrong
• Recipes and Examples for Specific Problems
• Getting the Latest Version
• Finding out What Went Wrong
• Build-time Messages
• Build-Time Python Errors
• Getting Debug Messages
• Getting Python's Verbose Imports
• Helping PyInstaller Find Modules
• Extending the Path
• Listing Hidden Imports
• Extending a Package's __path__
• Changing Runtime Behavior
• Advanced Topics
• The Bootstrap Process in Detail
• Bootloader
• Running Python code
• Python imports in a frozen app
• "Adapting to being ""frozen"""
• Accessing Data Files
• Capturing Version Data
• Inspecting Archives
• ZlibArchive
• CArchive
• Using pyi-archive_viewer
• Inspecting Executables
• Multipackage Bundles
• MERGE Function
• Example MERGE spec file
• Using Hook Files
• Hooks in Detail
• Building the Bootloader
• Development tools
• Building
• Linux Standard Base (LSB) binary
• Modulefinder Replacement - ImportTracker
• ImportTracker
• analyze_one()
• Module Classes
• code scanning
• Hooks
• Warnings
• Cross Reference
• Outdated Features
• Windows COM Server Support
• Building Optimized
• iu.py: An imputil Replacement
• ImportManager
• ImportDirector
• PathImportDirector
• Owner
• Packages
• Possibilities
• Compatibility
• Performance
• Limitations
• iu Usage
• iu.py