Packages and Binaries:
python3-pyinstaller
PyInstaller is a program that converts (packages) Python programs into stand- alone executables, under Windows, Linux, Mac OS X, Solaris and AIX. Its main advantages over similar tools are that PyInstaller works with any version of Python since 2.3, it builds smaller executables thanks to transparent compression, it is fully multi-platform, and use the OS support to load the dynamic libraries, thus ensuring full compatibility.
The main goal of PyInstaller is to be compatible with 3rd-party packages out -of-the-box. This means that, with PyInstaller, all the required tricks to make external packages work are already integrated within PyInstaller itself so that there is no user intervention required. You’ll never be required to look for tricks in wikis and apply custom modification to your files or your setup scripts. As an example, libraries like PyQt, Django or matplotlib are fully supported, without having to handle plugins or external data files manually.
Installed size: 4.98 MB
How to install: sudo apt install python3-pyinstaller
Dependencies:
- python3
- python3-altgraph
- python3-importlib-metadata | python3-supported-min
- python3-packaging
- python3-pkg-resources
- python3-pyinstaller-hooks-contrib
pyi-archive_viewer
root@kali:~# pyi-archive_viewer -h
usage: pyi-archive_viewer [-h] [-l] [-r] [-b] [--log-level LEVEL] pyi_archive
positional arguments:
pyi_archive PyInstaller archive to process.
options:
-h, --help show this help message and exit
-l, --list List the archive contents and exit (default: False).
-r, --recursive Recursively print an archive log (default: False).
Implies --list.
-b, --brief When displaying archive contents, show only file names.
(default: False).
--log-level LEVEL Amount of detail in build-time console messages. LEVEL
may be one of TRACE, DEBUG, INFO, WARN, DEPRECATION,
ERROR, FATAL (default: INFO). Also settable via and
overrides the PYI_LOG_LEVEL environment variable.
pyi-bindepend
root@kali:~# pyi-bindepend -h
usage: pyi-bindepend [-h] [--log-level LEVEL]
executable-or-dynamic-library
[executable-or-dynamic-library ...]
positional arguments:
executable-or-dynamic-library
executables or dynamic libraries for which the
dependencies should be shown
options:
-h, --help show this help message and exit
--log-level LEVEL Amount of detail in build-time console messages. LEVEL
may be one of TRACE, DEBUG, INFO, WARN, DEPRECATION,
ERROR, FATAL (default: INFO). Also settable via and
overrides the PYI_LOG_LEVEL environment variable.
pyi-grab_version
root@kali:~# pyi-grab_version -h
usage: pyi-grab_version [-h] exe-file [out-filename]
positional arguments:
exe-file full pathname of a Windows executable
out-filename filename where the grabbed version info will be saved
options:
-h, --help show this help message and exit
The printed output may be saved to a file, edited and used as the input for a
version resource on any of the executable targets in a PyInstaller .spec file.
pyi-makespec
root@kali:~# pyi-makespec -h
usage: pyi-makespec [-h] [-D] [-F] [--specpath DIR] [-n NAME]
[--contents-directory CONTENTS_DIRECTORY]
[--add-data SOURCE:DEST] [--add-binary SOURCE:DEST]
[-p DIR] [--hidden-import MODULENAME]
[--collect-submodules MODULENAME]
[--collect-data MODULENAME]
[--collect-binaries MODULENAME] [--collect-all MODULENAME]
[--copy-metadata PACKAGENAME]
[--recursive-copy-metadata PACKAGENAME]
[--additional-hooks-dir HOOKSPATH]
[--runtime-hook RUNTIME_HOOKS] [--exclude-module EXCLUDES]
[--splash IMAGE_FILE]
[-d {all,imports,bootloader,noarchive}] [--optimize LEVEL]
[--python-option PYTHON_OPTION] [-s] [--noupx]
[--upx-exclude FILE] [-c] [-w]
[--hide-console {minimize-early,minimize-late,hide-early,hide-late}]
[-i <FILE.ico or FILE.exe,ID or FILE.icns or Image or "NONE">]
[--disable-windowed-traceback] [--version-file FILE]
[-m <FILE or XML>] [-r RESOURCE] [--uac-admin]
[--uac-uiaccess] [--argv-emulation]
[--osx-bundle-identifier BUNDLE_IDENTIFIER]
[--target-architecture ARCH]
[--codesign-identity IDENTITY]
[--osx-entitlements-file FILENAME] [--runtime-tmpdir PATH]
[--bootloader-ignore-signals] [--log-level LEVEL]
scriptname [scriptname ...]
positional arguments:
scriptname
options:
-h, --help show this help message and exit
--log-level LEVEL Amount of detail in build-time console messages. LEVEL
may be one of TRACE, DEBUG, INFO, WARN, DEPRECATION,
ERROR, FATAL (default: INFO). Also settable via and
overrides the PYI_LOG_LEVEL environment variable.
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)
--contents-directory CONTENTS_DIRECTORY
For onedir builds only, specify the name of the
directory in which all supporting files (i.e.
everything except the executable itself) will be
placed in. Use "." to re-enable old onedir layout
without contents directory.
What to bundle, where to search:
--add-data SOURCE:DEST
Additional data files or directories containing data
files to be added to the application. The argument
value should be in form of "source:dest_dir", where
source is the path to file (or directory) to be
collected, dest_dir is the destination directory
relative to the top-level application directory, and
both paths are separated by a colon (:). To put a file
in the top-level application directory, use . as a
dest_dir. This option can be used multiple times.
--add-binary SOURCE:DEST
Additional binary files to be added to the executable.
See the ``--add-data`` option for the format. This
option can be used multiple times.
-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. Equivalent to
supplying the ``pathex`` argument in the spec file.
--hidden-import MODULENAME, --hiddenimport MODULENAME
Name an import not visible in the code of the
script(s). This option can be used multiple times.
--collect-submodules MODULENAME
Collect all submodules from the specified package or
module. This option can be used multiple times.
--collect-data MODULENAME, --collect-datas MODULENAME
Collect all data from the specified package or module.
This option can be used multiple times.
--collect-binaries MODULENAME
Collect all binaries from the specified package or
module. This option can be used multiple times.
--collect-all MODULENAME
Collect all submodules, data files, and binaries from
the specified package or module. This option can be
used multiple times.
--copy-metadata PACKAGENAME
Copy metadata for the specified package. This option
can be used multiple times.
--recursive-copy-metadata PACKAGENAME
Copy metadata for the specified package and all its
dependencies. This option can be used multiple times.
--additional-hooks-dir HOOKSPATH
An additional path to search for hooks. This option
can be used multiple times.
--runtime-hook RUNTIME_HOOKS
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.
--exclude-module EXCLUDES
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.
--splash IMAGE_FILE (EXPERIMENTAL) Add an splash screen with the image
IMAGE_FILE to the application. The splash screen can
display progress updates while unpacking.
How to generate:
-d {all,imports,bootloader,noarchive}, --debug {all,imports,bootloader,noarchive}
R|Provide assistance with debugging a frozen
application. This argument may be provided multiple
times to select several of the following options. -
all: All three of the following options. - imports:
specify the -v option to the underlying Python
interpreter, causing it to print a message each time a
module is initialized, showing the place (filename or
built-in module) from which it is loaded. See
https://docs.python.org/3/using/cmdline.html#id4. -
bootloader: tell the bootloader to issue progress
messages while initializing and starting the bundled
app. Used to diagnose problems with missing imports. -
noarchive: instead of storing all frozen Python source
files as an archive inside the resulting executable,
store them as files in the resulting output directory.
--optimize LEVEL Bytecode optimization level used for collected python
modules and scripts. For details, see the section
“Bytecode Optimization Level” in PyInstaller manual.
--python-option PYTHON_OPTION
Specify a command-line option to pass to the Python
interpreter at runtime. Currently supports "v"
(equivalent to "--debug imports"), "u", "W <warning
control>", "X <xoption>", and "hash_seed=<value>". For
details, see the section "Specifying Python
Interpreter Options" in PyInstaller manual.
-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)
--upx-exclude FILE 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 has 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 this also triggers
building a Mac OS .app bundle. On Windows this option
is automatically set if the first script is a '.pyw'
file. This option is ignored on *NIX systems.
--hide-console {minimize-early,minimize-late,hide-early,hide-late}
Windows only: in console-enabled executable, have
bootloader automatically hide or minimize the console
window if the program owns the console window (i.e.,
was not launched from an existing console window).
-i <FILE.ico or FILE.exe,ID or FILE.icns or Image or "NONE">, --icon <FILE.ico or FILE.exe,ID or FILE.icns or Image or "NONE">
FILE.ico: apply the 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. If an image file is entered that isn't in the
platform format (ico on Windows, icns on Mac),
PyInstaller tries to use Pillow to translate the icon
into the correct format (if Pillow is installed). Use
"NONE" to not apply any icon, thereby making the OS
show some default (default: apply PyInstaller's icon).
This option can be used multiple times.
--disable-windowed-traceback
Disable traceback dump of unhandled exception in
windowed (noconsole) mode (Windows and macOS only),
and instead display a message that this feature is
disabled.
Windows specific options:
--version-file FILE 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 that will request
elevation upon application start.
--uac-uiaccess Using this option allows an elevated application to
work with Remote Desktop.
Mac OS specific options:
--argv-emulation Enable argv emulation for macOS app bundles. If
enabled, the initial open document/URL event is
processed by the bootloader and the passed file paths
or URLs are appended to sys.argv.
--osx-bundle-identifier BUNDLE_IDENTIFIER
Mac OS .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)
--target-architecture ARCH, --target-arch ARCH
Target architecture (macOS only; valid values: x86_64,
arm64, universal2). Enables switching between
universal2 and single-arch version of frozen
application (provided python installation supports the
target architecture). If not target architecture is
not specified, the current running architecture is
targeted.
--codesign-identity IDENTITY
Code signing identity (macOS only). Use the provided
identity to sign collected binaries and generated
executable. If signing identity is not provided, ad-
hoc signing is performed instead.
--osx-entitlements-file FILENAME
Entitlements file to use when code-signing the
collected binaries (macOS only).
Rarely used special options:
--runtime-tmpdir PATH
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 ``_MEIxxxxxx``-folder
will be created here. Please use this option only if
you know what you are doing. Note that on POSIX
systems, PyInstaller's bootloader does NOT perform
shell-style environment variable expansion on the
given path string. Therefore, using environment
variables (e.g., ``~`` or ``$HOME``) in path will NOT
work.
--bootloader-ignore-signals
Tell the bootloader to ignore signals rather than
forwarding them to the child process. Useful in
situations where for example a supervisor process
signals both the bootloader and the child (e.g., via a
process group) to avoid signalling the child twice.
pyi-set_version
root@kali:~# pyi-set_version -h
usage: pyi-set_version [-h] info-file exe-file
positional arguments:
info-file text file containing version info
exe-file full pathname of a Windows executable
options:
-h, --help show this help message and exit
pyinstaller
root@kali:~# pyinstaller -h
usage: pyinstaller [-h] [-v] [-D] [-F] [--specpath DIR] [-n NAME]
[--contents-directory CONTENTS_DIRECTORY]
[--add-data SOURCE:DEST] [--add-binary SOURCE:DEST]
[-p DIR] [--hidden-import MODULENAME]
[--collect-submodules MODULENAME]
[--collect-data MODULENAME] [--collect-binaries MODULENAME]
[--collect-all MODULENAME] [--copy-metadata PACKAGENAME]
[--recursive-copy-metadata PACKAGENAME]
[--additional-hooks-dir HOOKSPATH]
[--runtime-hook RUNTIME_HOOKS] [--exclude-module EXCLUDES]
[--splash IMAGE_FILE]
[-d {all,imports,bootloader,noarchive}] [--optimize LEVEL]
[--python-option PYTHON_OPTION] [-s] [--noupx]
[--upx-exclude FILE] [-c] [-w]
[--hide-console {minimize-late,hide-early,minimize-early,hide-late}]
[-i <FILE.ico or FILE.exe,ID or FILE.icns or Image or "NONE">]
[--disable-windowed-traceback] [--version-file FILE]
[-m <FILE or XML>] [-r RESOURCE] [--uac-admin]
[--uac-uiaccess] [--argv-emulation]
[--osx-bundle-identifier BUNDLE_IDENTIFIER]
[--target-architecture ARCH] [--codesign-identity IDENTITY]
[--osx-entitlements-file FILENAME] [--runtime-tmpdir PATH]
[--bootloader-ignore-signals] [--distpath DIR]
[--workpath WORKPATH] [-y] [--upx-dir UPX_DIR] [--clean]
[--log-level LEVEL]
scriptname [scriptname ...]
positional arguments:
scriptname Name of scriptfiles to be processed or exactly one
.spec file. If a .spec file is specified, most options
are unnecessary and are ignored.
options:
-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)
--workpath WORKPATH Where to put all the temporary work files, .log, .pyz
and etc. (default: ./build)
-y, --noconfirm Replace output directory (default:
SPECPATH/dist/SPECNAME) without asking for
confirmation
--upx-dir UPX_DIR Path to UPX utility (default: search the execution
path)
--clean Clean PyInstaller cache and remove temporary files
before building.
--log-level LEVEL Amount of detail in build-time console messages. LEVEL
may be one of TRACE, DEBUG, INFO, WARN, DEPRECATION,
ERROR, FATAL (default: INFO). Also settable via and
overrides the PYI_LOG_LEVEL environment variable.
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)
--contents-directory CONTENTS_DIRECTORY
For onedir builds only, specify the name of the
directory in which all supporting files (i.e.
everything except the executable itself) will be
placed in. Use "." to re-enable old onedir layout
without contents directory.
What to bundle, where to search:
--add-data SOURCE:DEST
Additional data files or directories containing data
files to be added to the application. The argument
value should be in form of "source:dest_dir", where
source is the path to file (or directory) to be
collected, dest_dir is the destination directory
relative to the top-level application directory, and
both paths are separated by a colon (:). To put a file
in the top-level application directory, use . as a
dest_dir. This option can be used multiple times.
--add-binary SOURCE:DEST
Additional binary files to be added to the executable.
See the ``--add-data`` option for the format. This
option can be used multiple times.
-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. Equivalent to
supplying the ``pathex`` argument in the spec file.
--hidden-import MODULENAME, --hiddenimport MODULENAME
Name an import not visible in the code of the
script(s). This option can be used multiple times.
--collect-submodules MODULENAME
Collect all submodules from the specified package or
module. This option can be used multiple times.
--collect-data MODULENAME, --collect-datas MODULENAME
Collect all data from the specified package or module.
This option can be used multiple times.
--collect-binaries MODULENAME
Collect all binaries from the specified package or
module. This option can be used multiple times.
--collect-all MODULENAME
Collect all submodules, data files, and binaries from
the specified package or module. This option can be
used multiple times.
--copy-metadata PACKAGENAME
Copy metadata for the specified package. This option
can be used multiple times.
--recursive-copy-metadata PACKAGENAME
Copy metadata for the specified package and all its
dependencies. This option can be used multiple times.
--additional-hooks-dir HOOKSPATH
An additional path to search for hooks. This option
can be used multiple times.
--runtime-hook RUNTIME_HOOKS
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.
--exclude-module EXCLUDES
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.
--splash IMAGE_FILE (EXPERIMENTAL) Add an splash screen with the image
IMAGE_FILE to the application. The splash screen can
display progress updates while unpacking.
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.
- all: All three of the following options.
- imports: specify the -v option to the underlying
Python interpreter, causing it to print a message
each time a module is initialized, showing the
place (filename or built-in module) from which it
is loaded. See
https://docs.python.org/3/using/cmdline.html#id4.
- bootloader: tell the bootloader to issue progress
messages while initializing and starting the
bundled app. Used to diagnose problems with
missing imports.
- noarchive: instead of storing all frozen Python
source files as an archive inside the resulting
executable, store them as files in the resulting
output directory.
--optimize LEVEL Bytecode optimization level used for collected python
modules and scripts. For details, see the section
“Bytecode Optimization Level” in PyInstaller manual.
--python-option PYTHON_OPTION
Specify a command-line option to pass to the Python
interpreter at runtime. Currently supports "v"
(equivalent to "--debug imports"), "u", "W <warning
control>", "X <xoption>", and "hash_seed=<value>". For
details, see the section "Specifying Python
Interpreter Options" in PyInstaller manual.
-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)
--upx-exclude FILE 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 has 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 this also triggers
building a Mac OS .app bundle. On Windows this option
is automatically set if the first script is a '.pyw'
file. This option is ignored on *NIX systems.
--hide-console {minimize-late,hide-early,minimize-early,hide-late}
Windows only: in console-enabled executable, have
bootloader automatically hide or minimize the console
window if the program owns the console window (i.e.,
was not launched from an existing console window).
-i <FILE.ico or FILE.exe,ID or FILE.icns or Image or "NONE">, --icon <FILE.ico or FILE.exe,ID or FILE.icns or Image or "NONE">
FILE.ico: apply the 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. If an image file is entered that isn't in the
platform format (ico on Windows, icns on Mac),
PyInstaller tries to use Pillow to translate the icon
into the correct format (if Pillow is installed). Use
"NONE" to not apply any icon, thereby making the OS
show some default (default: apply PyInstaller's icon).
This option can be used multiple times.
--disable-windowed-traceback
Disable traceback dump of unhandled exception in
windowed (noconsole) mode (Windows and macOS only),
and instead display a message that this feature is
disabled.
Windows specific options:
--version-file FILE 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 that will request
elevation upon application start.
--uac-uiaccess Using this option allows an elevated application to
work with Remote Desktop.
Mac OS specific options:
--argv-emulation Enable argv emulation for macOS app bundles. If
enabled, the initial open document/URL event is
processed by the bootloader and the passed file paths
or URLs are appended to sys.argv.
--osx-bundle-identifier BUNDLE_IDENTIFIER
Mac OS .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)
--target-architecture ARCH, --target-arch ARCH
Target architecture (macOS only; valid values: x86_64,
arm64, universal2). Enables switching between
universal2 and single-arch version of frozen
application (provided python installation supports the
target architecture). If not target architecture is
not specified, the current running architecture is
targeted.
--codesign-identity IDENTITY
Code signing identity (macOS only). Use the provided
identity to sign collected binaries and generated
executable. If signing identity is not provided, ad-
hoc signing is performed instead.
--osx-entitlements-file FILENAME
Entitlements file to use when code-signing the
collected binaries (macOS only).
Rarely used special options:
--runtime-tmpdir PATH
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 ``_MEIxxxxxx``-folder
will be created here. Please use this option only if
you know what you are doing. Note that on POSIX
systems, PyInstaller's bootloader does NOT perform
shell-style environment variable expansion on the
given path string. Therefore, using environment
variables (e.g., ``~`` or ``$HOME``) in path will NOT
work.
--bootloader-ignore-signals
Tell the bootloader to ignore signals rather than
forwarding them to the child process. Useful in
situations where for example a supervisor process
signals both the bootloader and the child (e.g., via a
process group) to avoid signalling the child twice.
Updated on: 2024-Apr-25