| Author: | Giovanni Bajo |
|---|---|
| Copyright: | 2005-2011 by Giovanni Bajo, based on previous work under copyright 2002 McMillan Enterprises, Inc. |
| Version: | PyInstaller 3.0.dev8+f1a8933.mod |
| Manual section: | 1 |
pyinstaller <options> SCRIPT
Automatically calls pyi-configure, pyi-makespec and pyi-build in one run. In most cases, running pyinstaller will be all you have to do.
Please see the PyInstaller Manual for more information.
| -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) | |
| -a, --ascii | Do not include unicode encoding support (default: included if available) |
| --clean | Clean PyInstaller cache and remove temporary files before building. |
| --log-level=LOGLEVEL | |
| Amount of detail in build-time console messages (default: INFO, choose one of DEBUG, INFO, WARN, ERROR, CRITICAL) | |
| -F, --onefile | Create a one-file bundled executable. |
| -D, --onedir | Create a one-folder bundle containing an executable (default) |
| --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) | |
| -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 | |
| Name an import not visible in the code of the script(s). 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 (his Python names,not path names) that will be ignored (as thoughit was not found).This option can be used multiple times. | |
| --key=KEY | The key used to encrypt Python bytecode. |
| -d, --debug | Tell the bootloader to issue progress messages while initializing and starting the bundled app. Used to diagnose problems with missing imports. |
| -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) |
| -c, --console, --nowindowed | |
| Open a console window for standard i/o (default) | |
| -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.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 | |
| --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 <FILE[,TYPE[,NAME[,LANGUAGE]]]>, --resource=<FILE[,TYPE[,NAME[,LANGUAGE]]]> | |
| Add or update a resource of the given type, name and language from FILE to a Windows executable. 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. |
| --win-private-assemblies | |
| 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. | |
| --win-no-prefer-redirects | |
| 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. | |
| --osx-bundle-identifier=BUNDLE_IDENTIFIER | |
| 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) | |
| PYINSTALLER_CONFIG_DIR | This changes the directory where PyInstaller caches some files. The default location for this is operating system dependent, but is typically a subdirectory of the home directory. |
pyi-configure(1), pyi-makespec(1), pyi-build(1), The PyInstaller Manual, pyinstaller(1)
Project Homepage http://www.pyinstaller.org