Packaging User Guide

So you want to package a Python application using PyOxidizer? You’ve come to the right place to learn how! Read on for all the details on how to oxidize your Python application!

First, you’ll need to install PyOxidizer. See Installing for instructions.

• Creating a PyOxidizer Project
• Packaging Primitives in pyoxidizer.bzl Files
  • Targets Define Actions
  • Defining an Executable Embedding Python
  • Configuring the Python Interpreter Run-Time Behavior
  • Adding Python Packages to Executables
  • Install Manifests Copy Files Next to Your Application
• Understanding Python Distributions
  • Available Python Distributions
  • Python Version Compatibility
  • Choosing a Python Distribution
  • Binary Portability of Distributions
  • Known Issues with Distributions
• Managing How Resources are Added
  • Classified Resources Versus Files
  • Packaging Policies and Adding Resources
  • Resource Types
  • Resource Locations
  • Customizing Python Packaging Policies
  • PythonExtensionModule Location Compatibility
• Packaging Python Files
  • PythonExecutable Python Resources Methods
  • Packaging an Application from a PyPI Package
  • Packaging an Application from an Existing Virtualenv
  • Packaging an Application from a Local Python Package
  • Choosing Which Packaging Method to Call
• Packaging Files Instead of In-Memory Resources
  • Examples of Packaging Failures
  • Installing Classified Resources on the Filesystem
  • Installing Unclassified Files on the Filesystem
• Working with Python Extension Modules
  • Extension Module Flavors
  • Extension Module Restrictions
  • Extension Module Library Dependencies
  • Building with a Custom Distutils
• Managing Packed Resources Data
  • Available Resource Data Load Modes
• Trimming Unused Resources
• Performance of Built Binaries
  • Resources Data Compiled Into Binary
  • Ignoring site
• Packaging Pitfalls
  • C and Other Native Extension Modules
  • Identifying PyOxidizer
  • Incorrect Resource Identification
• Masquerading As Other Packaging Tools
• Standalone / Single File Applications with Static Linking
  • Building Fully Statically Linked Binaries on Linux
  • Building Statically Linked Binaries on Windows
  • Implications of Static Linking
• Licensing Considerations
  • Showing Python Distribution Licenses
• Terminfo Database
• Using the multiprocessing Python Module
  • Worker Process Spawn Method
  • Automatic Detection and Dispatch of multiprocessing Processes
  • Dependence on sys.frozen
  • Sensitivity to sys.executable
  • Debugging multiprocessing Problems
• SSL Certificate Loading
  • How Python Looks for Certificates
  • Using Alternative Certificate Paths
• Using the tkinter Python Module
  • Installing tcl Files
  • tcl Files Prevent Self-Contained Executables
• Building an Executable that Behaves Like python
  • Resource Loading Caveats
  • Binary Portability