Skip to content

Latest commit

 

History

History
137 lines (84 loc) · 3.67 KB

README.rst

File metadata and controls

137 lines (84 loc) · 3.67 KB

PyInstaller Overview

PyInstaller is a program that converts (packages) Python programs into stand-alone executables, under Windows, Linux, Mac OS X, FreeBSD, AIX and Solaris.

https://ci.appveyor.com/api/projects/status/t7o4swychyh94wrs/branch/develop?svg=true Manual Changelog IRC
Documentation:https://pythonhosted.org/PyInstaller/
Website:http://www.pyinstaller.org
Code:https://github.com/pyinstaller/pyinstaller

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.
  • 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, 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 Supported 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 by found in the distribution-package glibc or libc-bin.
  • objdump: Console application to display information from object files. This typically can by found in the distribution-package binutils.
  • Mac OS X (64bit):
  • Mac OS X 10.6 (Snow Leopard) 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.

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

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