How to Install PyInstaller¶
PyInstaller is available as a regular Python package. The source archives for released versions are available from PyPi, but it is easier to install the latest version using pip:
To upgrade existing PyInstaller installation to the latest version, use:
To install the current development version, use:
To install directly using pip’s built-in git checkout support, use:
or to install specific branch (e.g., develop ):
Installing from the source archive¶
The source code archive for released versions of PyInstaller are available at PyPI and on PyInstaller Downloads page.
Even though the source archive provides the setup.py script, installation via python setup.py install has been deprecated and should not be used anymore. Instead, run pip install . from the unpacked source directory, as described below.
Unpack the source archive.
Move into the unpacked source directory.
Run pip install . from the unpacked source directory. If installing into system-wide python installation, administrator privilege is required.
The same procedure applies to installing from manual git checkout:
If you intend to make changes to the source code and want them to take effect immediately, without re-installing the package each time, you can install it in editable mode:
For platforms other than Windows, GNU/Linux and macOS, you must first build the bootloader for your platform: see Building the Bootloader . After the bootloader has been built, use the pip install . command 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, and 4.n.dev0-xxxxxx for a development branch.
If the command is not found, make sure the execution path includes the proper directory:
Windows: C:\PythonXY\Scripts where XY stands for the major and minor Python version number, for example C:\Python38\Scripts for Python 3.8)
macOS (using the default Apple-supplied Python) /usr/bin
macOS (using Python installed by homebrew) /usr/local/bin
macOS (using Python installed by macports) /opt/local/bin
To display the current path in Windows the command is echo %path% and in other systems, echo $PATH .
If you cannot use the pyinstaller command due to the scripts directory not being in PATH , you can instead invoke the PyInstaller module, by running python -m PyInstaller (pay attention to the module name, which is case sensitive). This form of invocation is also useful when you have PyInstaller installed in multiple python environments, and you cannot be sure from which installation the pyinstaller command will be ran.
Installed commands¶
The complete installation places these commands on the execution path:
pyinstaller is the main command to build a bundled application. See Using PyInstaller .
pyi-makespec is used to create a spec file. See Using Spec Files .
pyi-archive_viewer is used to inspect a bundled application. See Inspecting Archives .
pyi-bindepend is used to display dependencies of an executable. See Inspecting Executables .
pyi-grab_version is used to extract a version resource from a Windows executable. See Capturing Windows Version Data .
pyi-set_version can be used to apply previously-extracted version resource to an existing Windows executable.
© Copyright This document has been placed in the public domain.. Revision 4222dc4d .
How to install PyInstaller? [closed]
This question does not appear to be about a specific programming problem, a software algorithm, or software tools primarily used by programmers. If you believe the question would be on-topic on another Stack Exchange site, you can leave a comment to explain where the question may be able to be answered.
Closed 9 years ago .
I want to use PyInstaller. I could always create bin files with pyinstaller.py [args] .
- It’s not a package with an __init__.py file,
- it has no setup.py
- and it doesn’t work to create a folder, put it in my PYTHONPATH, put pyinstaller\[files] in that folder and then make a call to python pyinstaller\pyinstaller.py .
pyinstaller.org only tells me something with Configure.py .
So now I’m out of ideas how to install PyInstaller so that I don’t have to work with absolute paths. Do you have any ideas?
3 Answers 3
To install PyInstaller:
- Go to your command prompt (Start -> Run -> cmd)
- type the following command cd c:\python27\scripts press enter, this should be where your pip.exe file is located.
- Once you are in this directory type pip install pyinstaller press enter
Message should read Successfully installed pyinstaller .
![]()
/.wine/drive_c/Python26/Scripts/ ! PS: I am on wine in Ubuntu.
Как установить pyinstaller без pip
pip install PyInstaller
pyinstaller 5.1
PyInstaller bundles a Python application and all its dependencies into a single package.
Navigation
Project links
- Homepage
- Source
Statistics
- Stars:
- Forks:
- Open issues/PRs:
View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery
License: GNU General Public License v2 (GPLv2) (GPLv2-or-later with a special exception which allows to use PyInstaller to build and distribute non-free programs (including commercial ones))
Author: Hartmut Goebel, Giovanni Bajo, David Vierra, David Cortesi, Martin Zibricky
Tags packaging, app, apps, bundle, convert, standalone, executable, pyinstaller, cxfreeze, freeze, py2exe, py2app, bbfreeze
Requires: Python <3.11, >=3.7
Maintainers
Classifiers
- Development Status
- 6 — Mature
- Console
- Developers
- Other Audience
- System Administrators
- OSI Approved :: GNU General Public License v2 (GPLv2)
- English
- MacOS :: MacOS X
- Microsoft :: Windows
- POSIX
- POSIX :: AIX
- POSIX :: BSD
- POSIX :: Linux
- POSIX :: SunOS/Solaris
- C
- Python
- Python :: 3
- Python :: 3 :: Only
- Python :: 3.7
- Python :: 3.8
- Python :: 3.9
- Python :: 3.10
- Python :: Implementation :: CPython
- Software Development
- Software Development :: Build Tools
- Software Development :: Interpreters
- Software Development :: Libraries :: Python Modules
- System :: Installation/Setup
- System :: Software Distribution
- Utilities
Project description
PyInstaller bundles a Python application and all its dependencies into a single package. The user can run the packaged app without installing a Python interpreter or any modules.
Documentation: https://pyinstaller.readthedocs.io/ Website: http://www.pyinstaller.org/ Code: https://github.com/pyinstaller/pyinstaller PyInstaller reads a Python script written by you. It analyzes your code to discover every other module and library your script needs in order to execute. Then it collects copies of all those files – including the active Python interpreter! – and puts them with your script in a single folder, or optionally in a single executable file.
PyInstaller is tested against Windows, macOS, and GNU/Linux. However, it is not a cross-compiler: to make a Windows app you run PyInstaller in Windows; to make a GNU/Linux app you run it in GNU/Linux, etc. PyInstaller has been used successfully with AIX, Solaris, FreeBSD and OpenBSD, but is not tested against them as part of the continuous integration tests.
Main Advantages
- Works out-of-the-box with any Python version 3.7-3.10.
- Fully multi-platform, and uses the OS support to load the dynamic libraries, thus ensuring full compatibility.
- Correctly bundles the major Python packages such as numpy, PyQt5, PySide2, Django, wxPython, matplotlib and others out-of-the-box.
- 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, PySide2, wxPython, matplotlib or Django are fully supported, without having to handle plugins or external data files manually.
- Works with code signing on macOS.
- Bundles MS Visual C++ DLLs on Windows.
Installation
PyInstaller is available on PyPI. You can install it through pip :
Requirements and Tested Platforms
- Python:
- 3.7-3.10 1.0+ (only if using bytecode encryption). Instead of installing tinyaes, pip install pyinstaller[encryption] instead.
- Windows (32bit/64bit):
- PyInstaller should work on Windows 7 or newer, but we only officially support Windows 8+.
- Support for Python installed from the Windows store without using virtual environments requires PyInstaller 4.4 or later.
- GNU/Linux (32bit/64bit)
- ldd: Console application to print the shared libraries required by each program or shared library. This typically can be found in the distribution-package glibc or libc-bin .
- objdump: Console application to display information from object files. This typically can be found in the distribution-package binutils .
- objcopy: Console application to copy and translate object files. This typically can be found in the distribution-package binutils , too.
- macOS (64bit):
- macOS 10.15 (Catalina) or newer.
Usage
Basic usage is very simple, just run it against your main script:
For more details, see the manual.
Untested Platforms
The following platforms have been contributed and any feedback or enhancements on these are welcome.
- FreeBSD
- Solaris
- ldd
- objdump
- AIX 6.1 or newer. PyInstaller will not work with statically linked Python libraries.
- ldd
- PowerPC GNU/Linux (Debian)
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:
Then install PyInstaller:
or simply use it directly from the source (pyinstaller.py).
Support
See http://www.pyinstaller.org/support.html for how to find help as well as for commercial support.
Changes in this Release
You can find a detailed list of changes in this release in the Changelog section of the manual.
Project details
Project links
- Homepage
- Source
Statistics
- Stars:
- Forks:
- Open issues/PRs:
View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery
License: GNU General Public License v2 (GPLv2) (GPLv2-or-later with a special exception which allows to use PyInstaller to build and distribute non-free programs (including commercial ones))
Author: Hartmut Goebel, Giovanni Bajo, David Vierra, David Cortesi, Martin Zibricky
Tags packaging, app, apps, bundle, convert, standalone, executable, pyinstaller, cxfreeze, freeze, py2exe, py2app, bbfreeze
Name already in use
pyinstaller / doc / installation.rst
- Go to file T
- Go to line L
- Copy path
- Copy permalink
- Open with Desktop
- View raw
- Copy raw contents Copy raw contents
Copy raw contents
Copy raw contents
How to Install PyInstaller
PyInstaller is available as a regular Python package. The source archives for released versions are available from PyPi_ , but it is easier to install the latest version using pip_ :
To upgrade existing PyInstaller installation to the latest version, use:
To install the current development version, use:
To install directly using pip’s built-in git checkout support, use:
or to install specific branch (e.g., develop ):
Installing from the source archive
The source code archive for released versions of PyInstaller are available at PyPI_ and on `PyInstaller Downloads`_ page.
Even though the source archive provides the setup.py script, installation via python setup.py install has been deprecated and should not be used anymore. Instead, run pip install . from the unpacked source directory, as described below.
- Unpack the source archive.
- Move into the unpacked source directory.
- Run pip install . from the unpacked source directory. If installing into system-wide python installation, administrator privilege is required.
The same procedure applies to installing from manual git checkout:
If you intend to make changes to the source code and want them to take effect immediately, without re-installing the package each time, you can install it in editable mode:
For platforms other than Windows, GNU/Linux and macOS, you must first build the bootloader for your platform: see :ref:`Building the Bootloader` . After the bootloader has been built, use the pip install . command 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, and 4.n.dev0-xxxxxx for a development branch.
If the command is not found, make sure the execution path includes the proper directory:
- Windows: C:\PythonXY\Scripts where XY stands for the major and minor Python version number, for example C:\Python38\Scripts for Python 3.8)
- GNU/Linux: /usr/bin/
- macOS (using the default Apple-supplied Python) /usr/bin
- macOS (using Python installed by homebrew) /usr/local/bin
- macOS (using Python installed by macports) /opt/local/bin
To display the current path in Windows the command is echo %path% and in other systems, echo $PATH .
If you cannot use the pyinstaller command due to the scripts directory not being in PATH , you can instead invoke the PyInstaller module, by running python -m PyInstaller (pay attention to the module name, which is case sensitive). This form of invocation is also useful when you have PyInstaller installed in multiple python environments, and you cannot be sure from which installation the pyinstaller command will be ran.