Skip to main content

PyInstaller bundles a Python application and all its dependencies into a single package.

Project description

PyPI PyPI - Python Version Read the Docs (version) PyPI - Downloads

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.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.8-3.14.

  • 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, PyQt6, PySide6, wxPython, matplotlib and others out-of-the-box.

  • Compatible with many third-party packages out-of-the-box. (All the required tricks to make external packages work are already integrated.)

  • 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:

pip install pyinstaller

Requirements and Tested Platforms

  • Python:
    • 3.8-3.14. Note that Python 3.10.0 contains a bug making it unsupportable by PyInstaller. PyInstaller will also not work with beta releases of Python 3.15.

  • Windows (32-bit/64-bit/ARM64):
    • 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.

  • Linux:
    • GNU libc based distributions on architectures x86_64, aarch64, i686, ppc64le, s390x.

    • musl libc based distributions on architectures x86_64, aarch64.

    • 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.

    • Raspberry Pi users on armv5-armv7 should add piwheels as an extra index URL then pip install pyinstaller as usual.

  • macOS (x86_64 or arm64):
    • macOS 10.15 (Catalina) or newer.

    • Supports building universal2 applications provided that your installation of Python and all your dependencies are also compiled universal2.

Usage

Basic usage is very simple - just run it against your main script:

pyinstaller /path/to/yourscript.py

For more details, see the manual.

Untested Platforms

The following platforms have been contributed, and any feedback or enhancements on these are welcome.

  • FreeBSD
    • ldd

  • Solaris
    • ldd

    • objdump

  • AIX
    • AIX 6.1 or newer. PyInstaller will not work with statically linked Python libraries.

    • ldd

  • Linux on any other libc implementation/architecture combination not listed above.

Before using any contributed platform, you need to build the PyInstaller bootloader. This will happen automatically when you pip install pyinstaller provided that you have an appropriate C compiler (typically either gcc or clang) and zlib’s development headers already installed.

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyinstaller-6.17.0.tar.gz (4.0 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

pyinstaller-6.17.0-py3-none-win_arm64.whl (1.3 MB view details)

Uploaded Python 3Windows ARM64

pyinstaller-6.17.0-py3-none-win_amd64.whl (1.4 MB view details)

Uploaded Python 3Windows x86-64

pyinstaller-6.17.0-py3-none-win32.whl (1.3 MB view details)

Uploaded Python 3Windows x86

pyinstaller-6.17.0-py3-none-musllinux_1_1_x86_64.whl (736.8 kB view details)

Uploaded Python 3musllinux: musl 1.1+ x86-64

pyinstaller-6.17.0-py3-none-musllinux_1_1_aarch64.whl (736.9 kB view details)

Uploaded Python 3musllinux: musl 1.1+ ARM64

pyinstaller-6.17.0-py3-none-manylinux2014_x86_64.whl (737.8 kB view details)

Uploaded Python 3

pyinstaller-6.17.0-py3-none-manylinux2014_s390x.whl (738.1 kB view details)

Uploaded Python 3

pyinstaller-6.17.0-py3-none-manylinux2014_ppc64le.whl (741.1 kB view details)

Uploaded Python 3

pyinstaller-6.17.0-py3-none-manylinux2014_i686.whl (743.2 kB view details)

Uploaded Python 3

pyinstaller-6.17.0-py3-none-manylinux2014_aarch64.whl (732.0 kB view details)

Uploaded Python 3

pyinstaller-6.17.0-py3-none-macosx_10_13_universal2.whl (1.0 MB view details)

Uploaded Python 3macOS 10.13+ universal2 (ARM64, x86-64)

File details

Details for the file pyinstaller-6.17.0.tar.gz.

File metadata

  • Download URL: pyinstaller-6.17.0.tar.gz
  • Upload date:
  • Size: 4.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for pyinstaller-6.17.0.tar.gz
Algorithm Hash digest
SHA256 be372bd911392b88277e510940ac32a5c2a6ce4b8d00a311c78fa443f4f27313
MD5 e920c1dc33c685595cd029d2bf1a89e1
BLAKE2b-256 01809e0dad9c69a7cfd4b5aaede8c6225d762bab7247a2a6b7651e1995522001

See more details on using hashes here.

File details

Details for the file pyinstaller-6.17.0-py3-none-win_arm64.whl.

File metadata

  • Download URL: pyinstaller-6.17.0-py3-none-win_arm64.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3, Windows ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for pyinstaller-6.17.0-py3-none-win_arm64.whl
Algorithm Hash digest
SHA256 3c92a335e338170df7e615f75279cfeea97ade89e6dd7694943c8c185460f7b7
MD5 db77bfca86615b6e88dd3a12cf04847f
BLAKE2b-256 c49614991773c9e599707a53594429ccf372f9ee638df3b7d26b65fd1a7433f0

See more details on using hashes here.

File details

Details for the file pyinstaller-6.17.0-py3-none-win_amd64.whl.

File metadata

  • Download URL: pyinstaller-6.17.0-py3-none-win_amd64.whl
  • Upload date:
  • Size: 1.4 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for pyinstaller-6.17.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 b019940dbf7a01489d6b26f9fb97db74b504e0a757010f7ad078675befc85a82
MD5 da48bbd675e77ffc631433ded39b7066
BLAKE2b-256 2df56a122efe024433ecc34aab6f499e0bd2bbe059c639b77b0045aa2421b0bf

See more details on using hashes here.

File details

Details for the file pyinstaller-6.17.0-py3-none-win32.whl.

File metadata

  • Download URL: pyinstaller-6.17.0-py3-none-win32.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for pyinstaller-6.17.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 ce0be227a037fd4be672226db709088565484f597d6b230bceec19850fdd4c85
MD5 522f5d9d85045cbc8dab230d0f43b764
BLAKE2b-256 c784897d759198676b910d69d42640b6d25d50b449f2209e18127a974cf59dbe

See more details on using hashes here.

File details

Details for the file pyinstaller-6.17.0-py3-none-musllinux_1_1_x86_64.whl.

File metadata

File hashes

Hashes for pyinstaller-6.17.0-py3-none-musllinux_1_1_x86_64.whl
Algorithm Hash digest
SHA256 97f4c1942f7b4cd73f9e38b49cc8f5f8a6fbb44922cb60dd3073a189b77ee1ae
MD5 8c9910bff2e3efa3b9a7df3ac0a2101a
BLAKE2b-256 97e6bed54821c1ebe1275c559661d3e7bfa23c406673b515252dfbf89db56c65

See more details on using hashes here.

File details

Details for the file pyinstaller-6.17.0-py3-none-musllinux_1_1_aarch64.whl.

File metadata

File hashes

Hashes for pyinstaller-6.17.0-py3-none-musllinux_1_1_aarch64.whl
Algorithm Hash digest
SHA256 f8cfbbfa6708e54fb936df6dd6eafaf133e84efb0d2fe25b91cfeefa793c4ca4
MD5 31fd3fe4099c6805458a0e951aca290d
BLAKE2b-256 8d159dc0f81ccb746c27bfa6ee53164422fe47ee079c7a717d9c4791aba78797

See more details on using hashes here.

File details

Details for the file pyinstaller-6.17.0-py3-none-manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for pyinstaller-6.17.0-py3-none-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 2a147b83cdebb07855bd5a663600891550062373a2ca375c58eacead33741a27
MD5 7926314b3ff78b79ff5b898a262f1a3f
BLAKE2b-256 5e1ee8e36e1568f6865ac706c6e1f875c1a346ddaa9f9a8f923d66545d2240ed

See more details on using hashes here.

File details

Details for the file pyinstaller-6.17.0-py3-none-manylinux2014_s390x.whl.

File metadata

File hashes

Hashes for pyinstaller-6.17.0-py3-none-manylinux2014_s390x.whl
Algorithm Hash digest
SHA256 89c0d18ba8b62c6607abd8cf2299ae5ffa5c36d8c47f39608ce8c3f357f6099f
MD5 0b6f15434020dd1e906b666d5dae6db3
BLAKE2b-256 119d69fdacfd9335695f5900a376cfe3e4aed28f0720ffc15fee81fdb9d920bc

See more details on using hashes here.

File details

Details for the file pyinstaller-6.17.0-py3-none-manylinux2014_ppc64le.whl.

File metadata

File hashes

Hashes for pyinstaller-6.17.0-py3-none-manylinux2014_ppc64le.whl
Algorithm Hash digest
SHA256 cd213d1a545c97dfe4a3c40e8213ff7c5127fc115c49229f27a3fa541503444b
MD5 97e5a0c5da214e497a4f9ce3204cb7fd
BLAKE2b-256 a310c02bfbb050cafc4c353cf69baf95407e211e1372bd286ab5ce5cbc13a30a

See more details on using hashes here.

File details

Details for the file pyinstaller-6.17.0-py3-none-manylinux2014_i686.whl.

File metadata

File hashes

Hashes for pyinstaller-6.17.0-py3-none-manylinux2014_i686.whl
Algorithm Hash digest
SHA256 060b122e43e7c0b23e759a4153be34bd70914135ab955bb18a67181e0dca85a2
MD5 2402d248473f80a7e4a7d10902c9b400
BLAKE2b-256 4076f529de98f7e5cce7904c19b224990003fc2267eda2ee5fdd8452acb420a9

See more details on using hashes here.

File details

Details for the file pyinstaller-6.17.0-py3-none-manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for pyinstaller-6.17.0-py3-none-manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 aa9fd87aaa28239c6f0d0210114029bd03f8cac316a90bab071a5092d7c85ad7
MD5 e4cbd9d34717c8654cb0f21c2125cf98
BLAKE2b-256 9eb62e184879ab9cf90a1d2867fdd34d507c4d246b3cc52ca05aad00bfc70ee7

See more details on using hashes here.

File details

Details for the file pyinstaller-6.17.0-py3-none-macosx_10_13_universal2.whl.

File metadata

File hashes

Hashes for pyinstaller-6.17.0-py3-none-macosx_10_13_universal2.whl
Algorithm Hash digest
SHA256 4e446b8030c6e5a2f712e3f82011ecf6c7ead86008357b0d23a0ec4bcde31dac
MD5 87b0e11572374889e2bfb913ef709266
BLAKE2b-256 35f537e419d84d5284ecab11ef8b61306a3b978fe6f0fd69a9541e16bfd72e65

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page