Repository files navigation

PyInstaller bundles a Python application and all its dependencies into a singlepackage. The user can run the packaged app without installing a Pythoninterpreter or any modules.

PyInstaller reads a Python script written by you. It analyzes your codeto discover every other module and library your script needs in order toexecute. Then it collects copies of all those files -- including the activePython interpreter! -- and puts them with your script in a single folder, oroptionally in a single executable file.

PyInstaller is tested against Windows, macOS, and GNU/Linux.However, it is not a cross-compiler:to make a Windows app you run PyInstaller in Windows; to makea GNU/Linux app you run it in GNU/Linux, etc.PyInstaller has been used successfullywith AIX, Solaris, FreeBSD and OpenBSD,but is not tested against them as part of the continuous integration tests.

• Works out-of-the-box with any Python version 3.8-3.14.
• Fully multi-platform, and uses the OS support to load the dynamic libraries,thus ensuring full compatibility.
• Correctly bundles the major Python packages such as numpy, PyQt5,PySide2, PyQt6, PySide6, wxPython, matplotlib and others out-of-the-box.
• Compatible with many third-party packages out-of-the-box. (All the requiredtricks to make external packages work are already integrated.)
• Works with code signing on macOS.
• Bundles MS Visual C++ DLLs on Windows.

PyInstaller is available on PyPI. You can install it through pip:

pip install pyinstaller

• Python:

  • 3.8-3.14. Note that Python 3.10.0 contains a bug making it unsupportable byPyInstaller. PyInstaller will also not work with beta releases of Python3.15.

• Windows (32-bit/64-bit/ARM64):

  • PyInstaller should work on Windows 7 or newer, but we only officially support Windows 8+.
  • Support for Python installed from the Windows Store without using virtualenvironments requires PyInstaller 4.4 or later.

• Linux:

  • GNU libc based distributions on architecturesx86_64,aarch64,i686,ppc64le,s390x.
  • musl libc based distributions on architecturesx86_64,aarch64.
  • ldd: Console application to print the shared libraries requiredby each program or shared library. This typically can be found inthe distribution package glibc or libc-bin.
  • objdump: Console application to display information fromobject files. This typically can be found in thedistribution package binutils.
  • objcopy: Console application to copy and translate object files.This typically can be found in the distribution package binutils,too.
  • Raspberry Pi users onarmv5-armv7 shouldadd piwheels as an extraindex URL thenpip install pyinstalleras usual.

• macOS (x86_64 orarm64):

  • macOS 10.15 (Catalina) or newer.
  • Supports buildinguniversal2 applications provided that your installationof Python and all your dependencies are also compileduniversal2.

Basic usage is very simple - just run it against your main script:

pyinstaller /path/to/yourscript.py

For more details, see themanual.

The following platforms have been contributed, and any feedback orenhancements on these are welcome.

• FreeBSD

  • ldd

• Solaris

  • ldd
  • objdump

• AIX

  • AIX 6.1 or newer. PyInstaller will not work with staticallylinked Python libraries.
  • ldd

• Linux on any other libc implementation/architecture combination not listedabove.

Before using any contributed platform, you need to build the PyInstallerbootloader. This will happen automatically when youpip install pyinstallerprovided that you have an appropriate C compiler (typicallyeithergcc orclang) and zlib's development headers already installed.

• Official debugging guide:https://pyinstaller.org/en/v6.19.0/when-things-go-wrong.html
• Assorted user contributed help topics:https://github.com/pyinstaller/pyinstaller/wiki
• Web based Q&A forums:https://github.com/pyinstaller/pyinstaller/discussions
• Email based Q&A forums:https://groups.google.com/g/pyinstaller

You can find a detailed list of changes in this releasein theChangelog section of the manual.