Skip to content

/ pyinstaller

Freeze (package) Python programs into stand-alone executables
python python-3 bundle package
Python C Ruby Shell C++ Objective-C Other
  1. Python 77.9%
  2. C 20.4%
  3. Ruby 0.6%
  4. Shell 0.4%
  5. C++ 0.4%
  6. Objective-C 0.2%
  7. Other 0.1%
Branch: develop
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Latest commit

@fredrb
fredrb compat: consider Python<version> as possible library binary path (#4895) 
compat: consider Python<version> as possible library binary path on macOS

Fixes #4893
Python installation in OSX Brew has Python library binary as `Python3`
which is not considered when importing default binaries
Latest commit 7eb1c66 May 25, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Issues: fix typo in template Apr 18, 2020
PyInstaller compat: consider Python<version> as possible library binary path (#4895) May 25, 2020
bootloader bootloader/tests: Drop apple traceback (#4875) and unskip QtQml tests… May 16, 2020
doc docs: Update supported platforms. May 18, 2020
news compat: consider Python<version> as possible library binary path (#4895) May 25, 2020
old Update copyright-year. Jan 8, 2020
scripts Cleanup: Remove __future__ imports, unused imports, and update copyri… May 14, 2020
tests bootloader/tests: Drop apple traceback (#4875) and unskip QtQml tests… May 16, 2020
.dockerignore Tests: Add script and dockerfile for running tests in docker. May 29, 2018
.gitattributes Update .gitattributes. Jan 7, 2020
.gitignore git: Add pip wheel building cache to gitignore May 6, 2020
.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: Use new label in .pyup.yml. Jan 8, 2020
.travis.yml Test/CI: Fix Mac test failures. Apr 16, 2020
COPYING.txt License: Fix path for runtime-hooks. May 18, 2020
MANIFEST.in Adopt template for towncrier to our needs. Sep 6, 2018
README.rst Update README with supported platforms note. May 8, 2020
appveyor.yml Test/CI: Fix Mac test failures. Apr 16, 2020
archive_viewer.py Update license header in all files having one - wording only. Jan 8, 2020
bindepend.py Update license header in all files having one - wording only. Jan 8, 2020
grab_version.py Update license header in all files having one - wording only. Jan 8, 2020
makespec.py Update license header in all files having one - wording only. Jan 8, 2020
pyinstaller.py Update license header in all files having one - wording only. Jan 8, 2020
pyproject.toml pyproject.toml: Update config for towncrier. Jan 9, 2020
requirements.txt requirements: Sort to be aligned with setup.cfg. Feb 3, 2020
set_version.py Update license header in all files having one - wording only. Jan 8, 2020
setup.cfg stats: change case (#4819) Apr 19, 2020
setup.py setup: Remove imports of PyInstaller at top-level. Feb 3, 2020

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, FreeBSD and OpenBSD, but is not tested against them as part of the continuous integration tests.

Main Advantages

  • Works out-of-the-box with any Python version 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.
  • Works with 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:
  • 3.5-3.7
  • PyCrypto 2.4+ (only if using bytecode encryption)
  • Windows (32bit/64bit):
  • PyInstaller should work on Windows 7 or newer, but we only officially support Windows 8+.
  • We don't support Python installed from the Windows store when not using virtual environments due to permission errors that can't easily be fixed.
  • 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 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.