Freeze (package) Python programs into stand-alone executables

License: Other

Language: Python

Keywords: bundle, package, python, python-3

PyInstaller Overview

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

Travis CI test status (Linux) Travis CI test status (OS X) AppVeyor CI test status (Windows) Code health Manual Changelog IRC

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

PyInstaller is tested against Windows, Mac OS X, and Linux. However, it is not a cross-compiler: to make a Windows app you run PyInstaller in Windows; to make a Linux app you run it in Linux, etc. PyInstaller has been used successfully with AIX, Solaris, and FreeBSD, but is not tested against them.

Main Advantages

  • Works out-of-the-box with any Python version 2.7 / 3.3-3.5.
  • 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, PyQt4, PyQt5, PySide, Django, wxPython, matplotlib and others out-of-the-box.
  • Compatible with many 3rd-party packages out-of-the-box. (All the required tricks to make external packages work are already integrated.)
  • Libraries like PyQt5, PyQt4, PySide, wxPython, matplotlib or Django are fully supported, without having to handle plugins or external data files manually.
  • Working code signing on OS X.
  • Bundles MS Visual C++ DLLs on Windows.


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

pip install pyinstaller

Requirements and Tested Platforms

  • Python:
  • 2.7 or 3.3+
  • PyCrypto 2.4+ (only if using bytecode encryption)
  • Windows (32bit/64bit):
  • Windows XP or newer.
  • Linux (32bit/64bit)
  • ldd: Console application to print the shared libraries required by each program or shared library. This typically can be found in the distribution-package glibc or libc-bin.
  • objdump: Console application to display information from object files. This typically can be found in the distribution-package binutils.
  • objcopy: Console application to copy and translate object files. This typically can be found in the distribution-package binutils, too.
  • Mac OS X (64bit):
  • Mac OS X 10.7 (Lion) or newer.


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

pyinstaller /path/to/

For more details, see the manual.

Untested Platforms

The following platforms have been contributed and any feedback or enhancements on these are welcome.

  • FreeBSD
  • ldd
  • Solaris
  • ldd
  • objdump
  • AIX
  • AIX 6.1 or newer. PyInstaller will not work with statically linked Python libraries.
  • ldd

Before using any contributed platform, you need to build the PyInstaller bootloader, as we do not ship binary packages. Download PyInstaller source, and build the bootloader:

cd bootloader
python ./waf distclean all

Then install PyInstaller:

python install

or simply use it directly from the source (

Project Statistics

Sourcerank 9
Repository Size 38.4 MB
Stars 5,062
Forks 1,101
Watchers 214
Open issues 563
Dependencies 68
Contributors 108
Tags 27
Last updated
Last pushed

Top Contributors See all

Martin Zibricky Hartmut Goebel Giovanni Bajo David Vierra Nat Picker Matteo Bertini Cecil Curry Jonathan Springer Lorenzo Masini Florian Höch Glenn Ramsey Lorenzo Mancini dhyams William Caban Daniele Varrazzo Lorenzo Villani Konstantinos Koukopoulos Dustin Spicuzza mplatings kz26

Recent Tags See all

v3.2.1 January 15, 2017
v3.2 May 03, 2016
v3.1.1 January 31, 2016
v3.1 January 09, 2016
3.0 October 04, 2015
3.0.dev8 October 02, 2015
3.0.dev7 October 01, 2015
3.0.dev6 September 29, 2015
3.0.dev2 September 18, 2015
3.0.dev1 September 18, 2015
v2.1 September 27, 2013
v2.0 August 08, 2012
v1.5.1 August 01, 2011
v1.5.1-rc1 July 28, 2011
v1.5 May 05, 2011

Interesting Forks See all

PyInstaller official GIT repository(修正了windows下运行时路径不支持中文的问题)
Python - Other - Last pushed - 26 stars - 17 forks
*** Don't use this repo, go upstream: ***
Python - Other - Last pushed - 3 stars
Personal copy of the PyInstaller official GIT repository
Python - Other - Last pushed - 2 stars
PyInstaller official GIT repository
Python - Other - Last pushed - 2 stars
PyInstaller official GIT repository
Python - Other - Last pushed - 2 stars - 1 forks

Something wrong with this page? Make a suggestion

Last synced: 2017-11-24 18:53:28 UTC

Login to resync this repository