Skip to content
Freeze (package) Python programs into stand-alone executables
Python C Ruby Shell C++ Objective-C Other
Branch: develop
Clone or download
tangm and htgoebel hooks: Fix distutils detection if virtualenv is used.
Don't rely on virtualenv internals for system distutils detection, fixes #4064 

When run in a venv, `distutils` present in the venv is not suitable
for freezing, instead the system-wide `distutils` should be used.
`pyinstaller` relies on a pre-find-module-path hook to change the
search path to point to this system-wide `distutils` location.

To do this, it made use of a `distutils_path` attribute that was set
in `virtualenv`, which pointed to the system-wide `distutils` dir.
This `distutils_path` was never meant to be part `virtualenv`'s public
api. Consequently, as part of a change in virtualenv release 16.3
(pypa/virtualenv#1289), this `distutils_path`
points to the `__init.py__` of the system-wide `distutils` when run on
python >= 3.4, as opposed to the directory. Consequently, the
`os.path.dirname` used in the original hook returns the wrong result.

Rather than continuing to rely on the `distutils_path` attribute, the
hook now figures out where the system-wide python libs live
using, the same technique `virtualenv` uses (by checking for the
`opcode` module location).
Latest commit 46286a1 Aug 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add github funding.yml. Jul 15, 2019
PyInstaller hooks: Fix distutils detection if virtualenv is used. Aug 16, 2019
bootloader Bootloader build: wscript: Remove now useless special case. Aug 6, 2019
doc Doc: Fix typos. Aug 16, 2019
news hooks: Fix distutils detection if virtualenv is used. Aug 16, 2019
old Update copyright-year. Jan 2, 2019
scripts Update helper-script `update-copyright`. Jan 2, 2019
tests Tests: Add some missing copyright headers. Aug 15, 2019
.dockerignore Tests: Add script and dockerfile for running tests in docker. May 29, 2018
.gitattributes Tests: Test data should get consistent line ending regardless of host. Jun 7, 2019
.gitignore Misc: Revert changes to .gitignore. Nov 5, 2018
.landscape.yml Update .pylintrc and .landscape.yml Mar 29, 2016
.pylintrc Tests: Clean-up outdated modules from pylint-blacklist. Feb 20, 2018
.pyup.yml Tests/CI: Fix .pyup.yml syntax error. Nov 4, 2018
.travis.yml Test/CI: Fix Travis SSL failures under PyQt 5.13.0. Aug 1, 2019
COPYING.txt Update copyright-year. Jan 2, 2019
MANIFEST.in Adopt template for towncrier to our needs. Sep 6, 2018
README.rst Docs: Remove Python 3.4. Jul 9, 2019
appveyor.yml Test/CI: Move test_hooks to the non-libraries stage in Travis. May 12, 2019
archive_viewer.py Update copyright-year. Jan 2, 2019
bindepend.py Update copyright-year. Jan 2, 2019
grab_version.py Update copyright-year. Jan 2, 2019
makespec.py Update copyright-year. Jan 2, 2019
pyinstaller-gui.py Update copyright-year. Jan 2, 2019
pyinstaller.py Update copyright-year. Jan 2, 2019
pyproject.toml pyproject.toml: Remove PEP-518 "build-system" table. Feb 3, 2019
requirements.txt Depend: Make platform-specific dependencies conditional. May 14, 2019
set_version.py Update copyright-year. Jan 2, 2019
setup.cfg Release: Add a comment to setup.cfg. Jul 9, 2019
setup.py setup: Remove support for Python 3.4. Jul 9, 2019

README.rst

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.

Help keeping PyInstaller alive: Maintaining PyInstaller is a huge amount of work. PyInstaller development can only continue if users and companies provide sustainable funding. See http://www.pyinstaller.org/funding.html for how to support PyInstaller.

Documentation:https://pyinstaller.readthedocs.io/
Website:http://www.pyinstaller.org/
Code:https://github.com/pyinstaller/pyinstaller
Donate:
Bitcoin: 1JUFjawzWDR7Tc8z9TKXstVFdjkDY9FbtK

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 GNU/Linux. However, it is not a cross-compiler: to make a Windows app you run PyInstaller in Windows; to make a GNU/Linux app you run it in GNU/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.5-3.7.
  • 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.

Installation

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

pip install pyinstaller

Requirements and Tested Platforms

  • Python:
  • 2.7 or 3.5-3.7
  • PyCrypto 2.4+ (only if using bytecode encryption)
  • Windows (32bit/64bit):
  • Windows XP or newer.
  • GNU/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.

Usage

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

pyinstaller /path/to/yourscript.py

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
  • PowerPC GNU/Linux (Debian)

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 setup.py install

or simply use it directly from the source (pyinstaller.py).

Support

See http://www.pyinstaller.org/support.html for how to find help as well as for commercial support.

Funding

Maintaining PyInstaller is a huge amount of work. PyInstaller development can only continue if users and companies provide sustainable funding. See http://www.pyinstaller.org/funding.html for how to support PyInstaller.

You can’t perform that action at this time.