The syntax of the
pyinstaller command is:
pyinstaller[options] script [script …] | specfile
In the most simple case,
set the current directory to the location of your program
myscript.specin the same folder as the script.
- Creates a folder
buildin the same folder as the script if it does not exist.
- Writes some log files and working files in the
- Creates a folder
distin the same folder as the script if it does not exist.
- Writes the
myscriptexecutable folder in the
dist folder you find the bundled app you distribute to your users.
Normally you name one script on the command line. If you name more, all are analyzed and included in the output. However, the first script named supplies the name for the spec file and for the executable folder or file. Its code is the first to execute at run-time.
For certain uses you may edit the contents of
(described under Using Spec Files).
After you do this, you name the spec file to PyInstaller instead of the script:
myscript.spec file contains most of the information
provided by the options that were specified when
pyinstaller (or pyi-makespec)
was run with the script file as the argument.
You typically do not need to specify any options when running
pyinstaller with the spec file.
Only a few command-line options
have an effect when building from a spec file.
You may give a path to the script or spec file, for example
or, on Windows,
pyinstaller "C:\Documents and Settings\project\myscript.spec"
|-h, --help||show this help message and exit|
|-v, --version||Show program version info and exit.|
|--distpath DIR||Where to put the bundled app (default: ./dist)|
|Where to put all the temporary work files, .log, .pyz and etc. (default: ./build)|
|Replace output directory (default: SPECPATH/dist/SPECNAME) without asking for confirmation|
|Path to UPX utility (default: search the execution path)|
|-a, --ascii||Do not include unicode encoding support (default: included if available)|
|--clean||Clean PyInstaller cache and remove temporary files before building.|
|Amount of detail in build-time console messages. LEVEL may be one of TRACE, DEBUG, INFO, WARN, ERROR, CRITICAL (default: INFO).|
What to generate¶
|-D, --onedir||Create a one-folder bundle containing an executable (default)|
|-F, --onefile||Create a one-file bundled executable.|
|--specpath DIR||Folder to store the generated spec file (default: current directory)|
|-n NAME, --name NAME|
|Name to assign to the bundled app and spec file (default: first script’s basename)|
What to bundle, where to search¶
|--add-data <SRC;DEST or SRC:DEST>|
|Additional non-binary files or folders to be added to
the executable. The path separator is platform
|--add-binary <SRC;DEST or SRC:DEST>|
|Additional binary files to be added to the executable.
See the |
|-p DIR, --paths DIR|
|A path to search for imports (like using PYTHONPATH). Multiple paths are allowed, separated by ‘:’, or use this option multiple times|
|--hidden-import MODULENAME, --hiddenimport MODULENAME|
|Name an import not visible in the code of the script(s). This option can be used multiple times.|
|An additional path to search for hooks. This option can be used multiple times.|
|Path to a custom runtime hook file. A runtime hook is code that is bundled with the executable and is executed before any other code or module to set up special features of the runtime environment. This option can be used multiple times.|
|Optional module or package (the Python name, not the path name) that will be ignored (as though it was not found). This option can be used multiple times.|
|--key KEY||The key used to encrypt Python bytecode.|
How to generate¶
|-d <all,imports,bootloader,noarchive>, --debug <all,imports,bootloader,noarchive>|
Provide assistance with debugging a frozen application. This argument may be provided multiple times to select several of the following options.
|-s, --strip||Apply a symbol-table strip to the executable and shared libs (not recommended for Windows)|
|--noupx||Do not use UPX even if it is available (works differently between Windows and *nix)|
|Prevent a binary from being compressed when using upx. This is typically used if upx corrupts certain binaries during compression. FILE is the filename of the binary without path. This option can be used multiple times.|
Windows and Mac OS X specific options¶
|-c, --console, --nowindowed|
|Open a console window for standard i/o (default). On Windows this option will have no effect if the first script is a ‘.pyw’ file.|
|-w, --windowed, --noconsole|
|Windows and Mac OS X: do not provide a console window for standard i/o. On Mac OS X this also triggers building an OS X .app bundle. On Windows this option will be set if the first script is a ‘.pyw’ file. This option is ignored in *NIX systems.|
|-i <FILE.ico or FILE.exe,ID or FILE.icns>, --icon <FILE.ico or FILE.exe,ID or FILE.icns>|
|FILE.ico: apply that icon to a Windows executable. FILE.exe,ID, extract the icon with ID from an exe. FILE.icns: apply the icon to the .app bundle on Mac OS X|
Windows specific options¶
|add a version resource from FILE to the exe|
|-m <FILE or XML>, --manifest <FILE or XML>|
|add manifest FILE or XML to the exe|
|-r RESOURCE, --resource RESOURCE|
|Add or update a resource to a Windows executable. The RESOURCE is one to four items, FILE[,TYPE[,NAME[,LANGUAGE]]]. FILE can be a data file or an exe/dll. For data files, at least TYPE and NAME must be specified. LANGUAGE defaults to 0 or may be specified as wildcard * to update all resources of the given TYPE and NAME. For exe/dll files, all resources from FILE will be added/updated to the final executable if TYPE, NAME and LANGUAGE are omitted or specified as wildcard *.This option can be used multiple times.|
|--uac-admin||Using this option creates a Manifest which will request elevation upon application restart.|
|--uac-uiaccess||Using this option allows an elevated application to work with Remote Desktop.|
Windows Side-by-side Assembly searching options (advanced)¶
|Any Shared Assemblies bundled into the application will be changed into Private Assemblies. This means the exact versions of these assemblies will always be used, and any newer versions installed on user machines at the system level will be ignored.|
|While searching for Shared or Private Assemblies to bundle into the application, PyInstaller will prefer not to follow policies that redirect to newer versions, and will try to bundle the exact versions of the assembly.|
Mac OS X specific options¶
|Mac OS X .app bundle identifier is used as the default unique program name for code signing purposes. The usual form is a hierarchical name in reverse DNS notation. For example: com.mycompany.department.appname (default: first script’s basename)|
Rarely used special options¶
|Where to extract libraries and support files in
onefile-mode. If this option is given, the
bootloader will ignore any temp-folder location
defined by the run-time OS. The |
|Tell the bootloader to ignore signals rather than forwarding them to the child process. Useful in situations where e.g. a supervisor process signals both the bootloader and child (e.g. via a process group) to avoid signalling the child twice.|
Shortening the Command¶
Because of its numerous options, a full
can become very long.
You will run the same command again and again as you develop
You can put the command in a shell script or batch file,
using line continuations to make it readable.
For example, in GNU/Linux:
pyinstaller --noconfirm --log-level=WARN \ --onefile --nowindow \ --add-data="README:." \ --add-data="image1.png:img" \ --add-binary="libfoo.so:lib" \ --hidden-import=secret1 \ --hidden-import=secret2 \ --upx-dir=/usr/local/share/ \ myscript.spec
Or in Windows, use the little-known BAT file line continuation:
pyinstaller --noconfirm --log-level=WARN ^ --onefile --nowindow ^ --add-data="README;." ^ --add-data="image1.png;img" ^ --add-binary="libfoo.so;lib" ^ --hidden-import=secret1 ^ --hidden-import=secret2 ^ --icon=..\MLNMFLCN.ICO ^ myscript.spec
Running PyInstaller from Python code¶
If you want to run PyInstaller from within Python code use the
function of the
__main__ module and pass all command line arguments in as
a list, e.g.
import PyInstaller.__main__ PyInstaller.__main__.run([ '--name=%s' % package_name, '--onefile', '--windowed', '--add-binary=%s' % os.path.join('resource', 'path', '*.png'), '--add-data=%s' % os.path.join('resource', 'path', '*.txt'), '--icon=%s' % os.path.join('resource', 'path', 'icon.ico'), os.path.join('my_package', '__main__.py'), ])
Running PyInstaller with Python optimizations¶
When using this feature, you should be aware of how the Python bytecode
optimization mechanism works. When using
__debug__ is set
assert statements are removed from the bytecode.
-OO flag additionally removes docstrings.
Using this feature affects not only your main script, but all modules included by PyInstaller. If your code (or any module imported by your script) relies on these features, your program may break or have unexpected behavior.
PyInstaller can be run with Python optimization flags (
by executing it as a Python module, rather than using the
# run with basic optimizations python -O -m PyInstaller myscript.py # also discard docstrings python -OO -m PyInstaller myscript.py
Or, by explicitly setting the
PYTHONOPTIMIZE environment variable
to a non-zero value:
# Unix PYTHONOPTIMIZE=1 pyinstaller myscript.py # Windows set PYTHONOPTIMIZE=1 && pyinstaller myscript.py
You can use any PyInstaller options that are otherwise available with
pyinstaller command. For example:
python -O -m PyInstaller --onefile myscript.py
Alternatively, you can also use the path to pyinstaller:
python -O /path/to/pyinstaller myscript.py
UPX is a free utility available for most operating systems. UPX compresses executable files and libraries, making them smaller, sometimes much smaller. UPX is available for most operating systems and can compress a large number of executable file formats. See the UPX home page for downloads, and for the list of supported executable formats.
A compressed executable program is wrapped in UPX startup code that dynamically decompresses the program when the program is launched. After it has been decompressed, the program runs normally. In the case of a PyInstaller one-file executable that has been UPX-compressed, the full execution sequence is:
- The compressed program start up in the UPX decompressor code.
- After decompression, the program executes the PyInstaller bootloader, which creates a temporary environment for Python.
- The Python interpreter executes your script.
PyInstaller looks for UPX on the execution path
or the path specified with the
If UPX exists, PyInstaller applies it to the final executable,
--noupx option was given.
UPX has been used with PyInstaller output often, usually with no problems.
Encrypting Python Bytecode¶
To encrypt the Python bytecode modules stored in the bundle,
--key=key-string argument on
the command line.
For this to work, you must have the PyCrypto module installed. The key-string is a string of 16 characters which is used to encrypt each file of Python byte-code before it is stored in the archive inside the executable file.
Defining the Extraction Location¶
In rare cases, when you bundle to a single executable
(see Bundling to One File and How the One-File Program Works),
you may want to control the location of the temporary directory at compile
time. This can be done using the
--runtime-tmpdir option. If this option is
given, the bootloader will ignore any temp-folder location defined by the
run-time OS. Please use this option only if you know what you are doing.
Supporting Multiple Platforms¶
If you distribute your application for only one combination of OS and Python, just install PyInstaller like any other package and use it in your normal development setup.
Supporting Multiple Python Environments¶
When you need to bundle your application within one OS
but for different versions of Python and support libraries – for example,
a Python 3 version and a Python 2.7 version;
or a supported version that uses Qt4 and a development version that uses Qt5 –
we recommend you use virtualenv.
With virtualenv you can maintain different combinations of Python
and installed packages, and switch from one combination to another easily.
(If you work only with Python 3.4 and later,
python3 -m venv
does the same job, see module venv.)
- Use virtualenv to create as many different development environments as you need, each with its unique combination of Python and installed packages.
- Install PyInstaller in each environment.
- Use PyInstaller to build your application in each environment.
Note that when using virtualenv, the path to the PyInstaller commands is:
- Windows: ENV_ROOT\Scripts
- Others: ENV_ROOT/bin
Under Windows, the pip-Win package installs virtualenv and makes it especially easy to set up different environments and switch between them. Under GNU/Linux and Mac OS, you switch environments at the command line.
See PEP 405 for more information about Python virtual environments.
Supporting Multiple Operating Systems¶
If you need to distribute your application for more than one OS, for example both Windows and Mac OS X, you must install PyInstaller on each platform and bundle your app separately on each.
You can do this from a single machine using virtualization. The free virtualBox or the paid VMWare and Parallels allow you to run another complete operating system as a “guest”. You set up a virtual machine for each “guest” OS. In it you install Python, the support packages your application needs, and PyInstaller.
The Dropbox system is useful with virtual machines. Install a Dropbox client in each virtual machine, all linked to your Dropbox account. Keep a single copy of your script(s) in a Dropbox folder. Then on any virtual machine you can run PyInstaller thus:
cd ~/Dropbox/project_folder/src # GNU/Linux, Mac -- Windows similar rm *.pyc # get rid of modules compiled by another Python pyinstaller --workpath=path-to-local-temp-folder \ --distpath=path-to-local-dist-folder \ ...other options as required... \ ./myscript.py
PyInstaller reads scripts from the common Dropbox folder, but writes its work files and the bundled app in folders that are local to the virtual machine.
If you share the same home directory on multiple platforms, for example GNU/Linux and OS X, you will need to set the PYINSTALLER_CONFIG_DIR environment variable to different values on each platform otherwise PyInstaller may cache files for one platform and use them on the other platform, as by default it uses a subdirectory of your home directory as its cache location.
Capturing Windows Version Data¶
A Windows app may require a Version resource file. A Version resource contains a group of data structures, some containing binary integers and some containing strings, that describe the properties of the executable. For details see the Microsoft Version Information Structures page.
Version resources are complex and
some elements are optional, others required.
When you view the version tab of a Properties dialog,
there’s no simple relationship between
the data displayed and the structure of the resource.
For this reason PyInstaller includes the
It is invoked with the full path name of any Windows executable
that has a Version resource:
The command writes text that represents
a Version resource in readable form to standard output.
You can copy it from the console window or redirect it to a file.
Then you can edit the version information to adapt it to your program.
pyi-grab_version you can find an executable that displays the kind of
information you want, copy its resource data, and modify it to suit your package.
The version text file is encoded UTF-8 and may contain non-ASCII characters. (Unicode characters are allowed in Version resource string fields.) Be sure to edit and save the text file in UTF-8 unless you are certain it contains only ASCII string values.
Your edited version text file can be given with the
The text data is converted to a Version resource and
installed in the bundled app.
In a Version resource there are two 64-bit binary values,
In the version text file these are given as four-element tuples,
filevers=(2, 0, 4, 0), prodvers=(2, 0, 4, 0),
The elements of each tuple represent 16-bit values
from most-significant to least-significant.
For example the value
(2, 0, 4, 0) resolves to
0002000000040000 in hex.
You can also install a Version resource from a text file after
the bundled app has been created, using the
pyi-set_version utility reads a version text file as written
pyi-grab_version, converts it to a Version resource,
and installs that resource in the executable_file specified.
For advanced uses, examine a version text file as written by
You find it is Python code that creates a
The class definition for
VSVersionInfo is found in
utils/win32/versioninfo.py in the PyInstaller distribution folder.
You can write a program that imports
In that program you can
the contents of a version info text file to produce a
You can use the
.toRaw() method of that object to
produce a Version resource in binary form.
Or you can apply the
unicode() function to the object
to reproduce the version text file.
Building Mac OS X App Bundles¶
Under Mac OS X, PyInstaller always builds a UNIX executable in
If you specify
--onedir, the output is a folder named
containing supporting files and an executable named
If you specify
--onefile, the output is a single UNIX executable
Either executable can be started from a Terminal command line.
Standard input and output work as normal through that Terminal window.
If you specify
--windowed with either option, the
also contains an OS X application named
As you probably know, an application is a special type of folder.
The one built by PyInstaller contains a folder always named
Contents which contains:
- A folder
Frameworkswhich is empty.
- A folder
Resourcesthat contains an icon file.
- A file
Info.plistthat describes the app.
- A folder
MacOSthat contains the the executable and supporting files, just as in the
icon= argument to specify a custom icon for the application.
It will be copied into the
(If you do not specify an icon file, PyInstaller supplies a
icon-windowed.icns with the PyInstaller logo.)
osx-bundle-identifier= argument to add a bundle identifier.
This becomes the
CFBundleIdentifier used in code-signing
(see the PyInstaller code signing recipe
and for more detail, the Apple code signing overview technical note).
You can add other items to the
Info.plist by editing the spec file;
see Spec File Options for a Mac OS X Bundle below.
Making GNU/Linux Apps Forward-Compatible¶
Under GNU/Linux, PyInstaller does not bundle
(the C standard library, usually
glibc, the Gnu version) with the app.
Instead, the app expects to link dynamically to the
libc from the
local OS where it runs.
The interface between any app and
libc is forward compatible to
newer releases, but it is not backward compatible to older releases.
For this reason, if you bundle your app on the current version of GNU/Linux, it may fail to execute (typically with a runtime dynamic link error) if it is executed on an older version of GNU/Linux.
The solution is to always build your app on the oldest version of
GNU/Linux you mean to support.
It should continue to work with the
libc found on newer versions.
The GNU/Linux standard libraries such as
glibc are distributed in 64-bit
and 32-bit versions, and these are not compatible.
As a result you cannot bundle your app on a 32-bit system and run it
on a 64-bit installation, nor vice-versa.
You must make a unique version of the app for each word-length supported.
For Python >= 3.5 targeting Windows < 10, the developer needs to take special care to include the Visual C++ run-time .dlls: Python 3.5 uses Visual Studio 2015 run-time, which has been renamed into “Universal CRT“ and has become part of Windows 10. For Windows Vista through Windows 8.1 there are Windows Update packages, which may or may not be installed in the target-system. So you have the following options:
Build on Windows 7 which has been reported to work.
Include one of the VCRedist packages (the redistributable package files) into your application’s installer. This is Microsoft’s recommended way, see “Distributing Software that uses the Universal CRT“ in the above-mentioned link, numbers 2 and 3.
Install the Windows Software Development Kit (SDK) for Windows 10 and expand the .spec-file to include the required DLLs, see “Distributing Software that uses the Universal CRT“ in the above-mentioned link, number 6.
If you think, PyInstaller should do this by itself, please help improving PyInstaller.
Mac OS X¶
Making Mac OS X apps Forward-Compatible¶
In Mac OS X, components from one version of the OS are usually compatible with later versions, but they may not work with earlier versions.
The only way to be certain your app supports an older version of Mac OS X is to run PyInstaller in the oldest version of the OS you need to support.
For example, to be sure of compatibility with “Snow Leopard” (10.6) and later versions, you should execute PyInstaller in that environment. You would create a copy of Mac OS X 10.6, typically in a virtual machine. In it, install the desired level of Python (the default Python in Snow Leopard was 2.6, which PyInstaller no longer supports), and install PyInstaller, your source, and all its dependencies. Then build your app in that environment. It should be compatible with later versions of Mac OS X.
Building 32-bit Apps in Mac OS X¶
Older versions of Mac OS X supported both 32-bit and 64-bit executables. PyInstaller builds an app using the the word-length of the Python used to execute it. That will typically be a 64-bit version of Python, resulting in a 64-bit executable. To create a 32-bit executable, run PyInstaller under a 32-bit Python.
Python as installed in OS X will usually be executable in either 64- or 32-bit mode.
To verify this, apply the
file command to the Python executable:
$ file /usr/local/bin/python3 /usr/local/bin/python3: Mach-O universal binary with 2 architectures /usr/local/bin/python3 (for architecture i386): Mach-O executable i386 /usr/local/bin/python3 (for architecture x86_64): Mach-O 64-bit executable x86_64
The OS chooses which architecture to run, and typically defaults to 64-bit.
You can force the use of either architecture by name using the
$ /usr/local/bin/python3 Python 3.4.2 (v3.4.2:ab2c023a9432, Oct 5 2014, 20:42:22) [GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin Type "help", "copyright", "credits" or "license" for more information. >>> import sys; sys.maxsize 9223372036854775807 $ arch -i386 /usr/local/bin/python3 Python 3.4.2 (v3.4.2:ab2c023a9432, Oct 5 2014, 20:42:22) [GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin Type "help", "copyright", "credits" or "license" for more information. >>> import sys; sys.maxsize 2147483647
/usr/bin/python may circumvent the
specification and run 64-bit regardless.
(That is not the case if you apply
arch to a specific version
To make sure of running 32-bit in all cases, set the following environment variable:
VERSIONER_PYTHON_PREFER_32_BIT=yes arch -i386 /usr/bin/python pyinstaller --clean -F -w myscript.py
Getting the Opened Document Names¶
Support for OpenDocument events is broken in PyInstaller 3.0 owing to code changes needed in the bootloader to support current versions of Mac OS X. Do not attempt to use this feature until it has been fixed. If this feature is important to you, follow and comment on the status of PyInstaller Issue #1309.
When a user double-clicks a document of a type your application supports, or when a user drags a document icon and drops it on your application’s icon, Mac OS X launches your application and provides the name(s) of the opened document(s) in the form of an OpenDocument AppleEvent. This AppleEvent is received by the bootloader before your code has started executing.
The bootloader gets the names of opened documents from
the OpenDocument event and encodes them into the
string before starting your code.
Thus your code can query
sys.argv to get the names
of documents that should be opened at startup.
OpenDocument is the only AppleEvent the bootloader handles. If you want to handle other events, or events that are delivered after the program has launched, you must set up the appropriate handlers.