PyOxidizer

PyOxidizer is a utility that aims to solve the problem of how to distribute Python applications. See Overview for more or dive into Getting Started to learn how to start using PyOxidizer.

The official home of the PyOxidizer project is https://github.com/indygreg/PyOxidizer. Official documentation lives at Read The Docs (unreleased/latest commit, last release).

The pyoxidizer-users mailing list is a forum for users to discuss all things PyOxidizer.

If you want to financially contribute to PyOxidizer, do so on Patreon or via PayPal.

The creator and maintainer of PyOxidizer is Gregory Szorc.

• Overview
  • Benefits of PyOxidizer
  • Components
  • How It Works
• Getting Started
  • Python Requirements
  • Installing
  • High-Level Project Lifecycle
  • Your First PyOxidizer Project
  • The pyoxidizer.bzl Configuration File
  • Customizing Python and Packaging Behavior
• The pyoxidizer Command Line Tool
  • Creating New Projects with init-config-file
  • Creating New Rust Projects with init-rust-project
  • Adding PyOxidizer to an Existing Project with add
  • Building PyObject Projects with build
  • Running the Result of Building with run
  • Analyzing Produced Binaries with analyze
  • Inspecting Python Distributions
• Configuration Files
  • Automatic File Location Strategy
  • Concepts
  • Resource Attributes Influencing Adding
  • Global Symbols
  • Functions for Manipulating Global State
  • Functions for Managing Targets
  • Functions for Interacting with the Filesystem
  • FileContent
  • FileManifest
  • PythonDistribution
  • PythonEmbeddedResources
  • PythonExecutable
  • PythonExtensionModule
  • PythonInterpreterConfig
  • PythonModuleSource
  • PythonPackageResource
  • PythonPackageDistributionResource
  • PythonPackagingPolicy
• Packaging User Guide
  • Creating a PyOxidizer Project
  • Packaging Primitives in pyoxidizer.bzl Files
  • Understanding Python Distributions
  • Managing How Resources are Added
  • Packaging Python Files
  • Packaging Python Files Next to the Built Application
  • Working with Python Extension Modules
  • Trimming Unused Resources
  • Performance of Built Binaries
  • Packaging Pitfalls
  • Masquerading As Other Packaging Tools
  • Binary Compatibility
  • Static Linking
  • Licensing Considerations
  • Terminfo Database
• oxidized_importer Python Extension
  • Getting Started
  • Python Meta Path Finders
  • OxidizedFinder Python Type
  • OxidizedFinder Behavior and Compliance
  • oxidized_importer Python Resource Types
  • Resource Scanning APIs
  • Loading Resource Files
  • Freezing Applications with oxidized_importer
  • Common Issues
  • Security Implications of Loading Resources
• Python Packed Resources
  • Implementation
  • Specification
  • Design Considerations
  • Potential Future Features
• PyOxidizer for Rust Developers
  • Using Cargo with PyOxidizer Source Checkouts
  • Rust Projects
  • Crate Configuration
  • Controlling Python From Rust Code
  • Adding Extension Modules At Run-Time
  • Porting a Python Application to Rust
• Frequently Asked Questions
  • Where Can I Report Bugs / Send Feedback / Request Features?
  • Why Build Another Python Application Packaging Tool?
  • Can Python 2.7 Be Supported?
  • Why is Python 3.8 Required?
  • No python interpreter found of version 3.* Error When Building
  • Why Rust?
  • Why is the Rust Code… Not Great?
  • What is the Magic Sauce That Makes PyOxidizer Special?
  • Can Applications Import Python Modules from the Filesystem?
  • error while loading shared libraries: libcrypt.so.1: cannot open shared object file: No such file or directory When Building
• Project Status
  • What’s Working
  • Major Missing Features
  • Lesser Missing Features
  • Eventual Features
• Comparisons to Other Tools
  • PyInstaller
  • py2exe
  • py2app
  • cx_Freeze
  • Shiv
  • PEX
  • XAR
  • Docker / Running a Container
  • Nuitka
  • PyRun
  • pynsist
  • Bazel
• Contributing to PyOxidizer
  • As a User
  • As a Developer
  • Financial Contributions
• Project History
  • Blog Posts
  • Version History
• Technical Notes
  • CPython Initialization
  • CPython Importing Mechanism
  • sys.modules After Interpreter Init
  • Modules Imported by site.py
  • Random Notes
  • Desired Changes from Python to Aid PyOxidizer