How to Install PyInstaller¶
PyInstaller is a normal Python package. You can download the archive from PyPi, but it is easier to install using pip where is is available, for example:
pip install pyinstaller
or upgrade to a newer version:
pip install --upgrade pyinstaller
To install the current development version use:
pip install https://github.com/pyinstaller/pyinstaller/tarball/develop
Installing from the archive¶
If pip is not available, download the compressed archive from PyPI. If you are asked to test a problem using the latest development code, download the compressed archive from the develop branch of PyInstaller Downloads page.
Expand the archive.
Inside is a script named
python setup.py install
with administrator privilege to install or upgrade PyInstaller.
For platforms other than Windows, GNU/Linux and macOS, you must first
build a bootloader program for your platform: see Building the Bootloader.
After the bootloader has been created,
python setup.py install with administrator privileges
to complete the installation.
Verifying the installation¶
On all platforms, the command
pyinstaller should now exist on the
execution path. To verify this, enter the command:
The result should resemble
4.n for a released version,
4.n.dev0-xxxxxx for a development branch.
If the command is not found, make sure the execution path includes the proper directory:
C:\PythonXY\Scriptswhere XY stands for the major and minor Python version number, for example
C:\Python38\Scriptsfor Python 3.8)
macOS (using the default Apple-supplied Python)
macOS (using Python installed by homebrew)
macOS (using Python installed by macports)
To display the current path in Windows the command is
and in other systems,
The complete installation places these commands on the execution path:
pyinstalleris the main command to build a bundled application. See Using PyInstaller.
pyi-makespecis used to create a spec file. See Using Spec Files.
pyi-archive_vieweris used to inspect a bundled application. See Inspecting Archives.
pyi-bindependis used to display dependencies of an executable. See Inspecting Executables.
pyi-grab_versionis used to extract a version resource from a Windows executable. See Capturing Windows Version Data.
If you do not perform a complete installation
pip or executing
these commands will not be installed as commands.
However, you can still execute all the functions documented below
by running Python scripts found in the distribution folder.
The equivalent of the
pyinstaller command is
The other commands are found in
with meaningful names (