Data

Tools

Indexes

Applications

Experiments

Open Source Science

pyinstaller

Freeze (package) Python programs into stand-alone executables

https://github.com/pyinstaller/pyinstaller

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.5%) to scientific vocabulary

Keywords

bundle package py2app py2exe pyinstaller python python-3 python-to-exe
Last synced: 6 months ago · JSON representation

Repository

Freeze (package) Python programs into stand-alone executables

Basic Info
  • Host: GitHub
  • Owner: pyinstaller
  • License: other
  • Language: Python
  • Default Branch: develop
  • Homepage: http://www.pyinstaller.org
  • Size: 64.7 MB
Statistics
  • Stars: 12,580
  • Watchers: 229
  • Forks: 2,002
  • Open Issues: 287
  • Releases: 75
Topics
bundle package py2app py2exe pyinstaller python python-3 python-to-exe
Created about 14 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing Funding License Security

README.rst 

PyInstaller Overview
====================

.. image:: https://img.shields.io/pypi/v/pyinstaller
   :alt: PyPI
   :target: https://pypi.org/project/pyinstaller
.. image:: https://img.shields.io/pypi/pyversions/pyinstaller
   :alt: PyPI - Python Version
   :target: https://pypi.org/project/pyinstaller
.. image:: https://img.shields.io/readthedocs/pyinstaller/stable
   :alt: Read the Docs (version)
   :target: https://pyinstaller.org
.. image:: https://img.shields.io/pypi/dm/pyinstaller
   :alt: PyPI - Downloads
   :target: https://pypistats.org/packages/pyinstaller


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.13.
- 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 3rd-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`:

.. code:: bash

      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 (32bit/64bit/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:

.. code:: bash

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

- Official debugging guide: https://pyinstaller.org/en/v6.15.0/when-things-go-wrong.html
- Assorted user contributed help topics: https://github.com/pyinstaller/pyinstaller/wiki
- Web based Q&A forums: https://github.com/pyinstaller/pyinstaller/discussions
- Email based Q&A forums: https://groups.google.com/g/pyinstaller


Changes in this Release
-----------------------

You can find a detailed list of changes in this release
in the `Changelog`_ section of the manual.

.. _`manual`: https://pyinstaller.org/en/v6.15.0/
.. _`Changelog`: https://pyinstaller.org/en/v6.15.0/CHANGES.html

Owner

  • Name: PyInstaller
  • Login: pyinstaller
  • Kind: organization

Converts (packages) Python programs into stand-alone executables, under Windows, Linux, Mac OS X, AIX and Solaris.

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 789
  • Total pull requests: 762
  • Average time to close issues: 2 months
  • Average time to close pull requests: 6 days
  • Total issue authors: 634
  • Total pull request authors: 60
  • Average comments per issue: 4.21
  • Average comments per pull request: 1.39
  • Merged pull requests: 657
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 190
  • Pull requests: 255
  • Average time to close issues: 4 days
  • Average time to close pull requests: about 24 hours
  • Issue authors: 172
  • Pull request authors: 13
  • Average comments per issue: 2.95
  • Average comments per pull request: 0.98
  • Merged pull requests: 222
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • bersbersbers (11)
  • C0rn3j (8)
  • htgoebel (7)
  • Eichhof (7)
  • 17Reset (7)
  • dickreuter (6)
  • arossert (5)
  • BLKSerene (4)
  • danyeaw (4)
  • gernophil (4)
  • happymvd (4)
  • eshopblr (4)
  • mtsamorim (4)
  • paulocoutinhox (4)
  • brappier (3)
Pull Request Authors
  • rokm (382)
  • pyup-bot (169)
  • bwoodsend (65)
  • ghost (35)
  • danyeaw (10)
  • EssamFattah (8)
  • byehack (6)
  • sorenstoutner (5)
  • C0rn3j (4)
  • oaikenhead (4)
  • SnoopJ (3)
  • kcehvoin1 (3)
  • arossert (2)
  • Geo5 (2)
  • Temerold (2)
Top Labels
Issue Labels
triage (377) bug (72) feature (67) kind:support (45) solution:invalid (33) solution:not enough info (29) antivirus-false-positives (21) state:need info (19) not-our-bug (17) solution:duplicate (14) solution:won't fix (12) solution:read the manual (9) area:documentation (7) pull-request wanted (7) area:modulegraph (4) state:stale by author (3) area:bootloader (3) @low (2) platform:Windows (2) help wanted (2) @medium (2) @high (2) platform:Linux (1) platform:Other OS (1) Version 5 (1) spam (1) area:hooks (1) play-stupid-games-win-stupid-rewards (1) platform:conda (1) kind:to be discussed (1)
Pull Request Labels
area:tests/ci/pyup (169) area:hooks (9) area:tests/ci (8) area:modulegraph (6) area:test-suite (6) feature (3) @high (3) kind:refactoring (2) kind:to be discussed (1) Python:3.6 (1) state:needs more work (1) @low / cleanup (1) platform:OS X (1) Python:3.7 (1) DO NOT MERGE (1)

Packages

  • Total packages: 8
  • Total downloads:
    • pypi 4,185,942 last-month
  • Total docker downloads: 1,677,892,089
  • Total dependent packages: 333
    (may contain duplicates)
  • Total dependent repositories: 7,729
    (may contain duplicates)
  • Total versions: 180
  • Total maintainers: 3
  • Total advisories: 2
pypi.org: pyinstaller

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

  • Versions: 66
  • Dependent Packages: 331
  • Dependent Repositories: 7,678
  • Downloads: 4,185,907 Last month
  • Docker Downloads: 1,677,892,089
Rankings
Docker downloads count: 0.0%
Dependent packages count: 0.1%
Dependent repos count: 0.1%
Average: 0.2%
Stargazers count: 0.2%
Downloads: 0.2%
Forks count: 0.3%
Maintainers (2)
Legorooj bwoodsend
Advisories (2)
Last synced: 6 months ago
proxy.golang.org: github.com/pyinstaller/pyinstaller
  • Versions: 39
  • Dependent Packages: 0
  • Dependent Repositories: 1
Rankings
Forks count: 0.6%
Stargazers count: 0.6%
Average: 3.6%
Dependent repos count: 4.8%
Dependent packages count: 8.4%
Last synced: 6 months ago
proxy.golang.org: github.com/PyInstaller/PyInstaller
  • Versions: 39
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.5%
Average: 5.7%
Dependent repos count: 5.8%
Last synced: 6 months ago
conda-forge.org: pyinstaller
  • Homepage: http://www.pyinstaller.org
  • License: GPL-2.0-or-later WITH Bootloader-exception
  • Latest release: 5.6.2
    published over 3 years ago
  • Versions: 22
  • Dependent Packages: 1
  • Dependent Repositories: 25
Rankings
Stargazers count: 2.9%
Forks count: 2.9%
Dependent repos count: 7.3%
Average: 10.5%
Dependent packages count: 29.0%
Last synced: 6 months ago
anaconda.org: pyinstaller

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

  • Homepage: https://pyinstaller.org
  • License: GPL-2.0-or-later WITH Bootloader-exception AND Apache-2.0
  • Latest release: 6.12.0
    published 12 months ago
  • Versions: 11
  • Dependent Packages: 1
  • Dependent Repositories: 25
Rankings
Stargazers count: 7.6%
Forks count: 7.7%
Average: 19.0%
Dependent repos count: 30.0%
Dependent packages count: 30.6%
Last synced: 6 months ago
pypi.org: cs489-pyinstaller-testable-1

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

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 17 Last month
Rankings
Dependent packages count: 9.6%
Average: 36.6%
Dependent repos count: 63.6%
Maintainers (1)
CS489_PYInstaller
Last synced: 6 months ago
pypi.org: custom-fork-pyinstaller

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

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 9.7%
Average: 36.7%
Dependent repos count: 63.7%
Maintainers (1)
CS489_PYInstaller
Last synced: 6 months ago
pypi.org: custom-fork-pyinstaller-1

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

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 18 Last month
Rankings
Dependent packages count: 9.7%
Average: 36.7%
Dependent repos count: 63.7%
Maintainers (1)
CS489_PYInstaller
Last synced: 6 months ago

Dependencies

.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/ci.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/lint.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/lock-threads.yml actions
  • dessant/lock-threads v3 composite
.github/workflows/validate-new-news.yml actions
  • actions/checkout v3 composite
.github/workflows/wheel-builder.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
bootloader/Dockerfile docker
  • ${BASE} latest build
tests/scripts/Dockerfile docker
  • python 3.7 build
doc/requirements.txt pypi
  • Babel ==2.9.1
  • Jinja2 ==3.0.1
  • MarkupSafe ==2.0.1
  • Pygments ==2.9.0
  • Sphinx ==4.3.2
  • alabaster ==0.7.12
  • altgraph ==0.17
  • certifi ==2021.5.30
  • chardet ==4.0.0
  • docutils ==0.16
  • idna ==2.10
  • imagesize ==1.2.0
  • pyparsing ==2.4.7
  • pytz ==2021.1
  • requests ==2.25.1
  • snowballstemmer ==2.1.0
  • sphinx-autodoc-typehints ==1.12.0
  • sphinx-issues ==3.0.1
  • sphinx-rtd-theme ==0.5.2
  • sphinxcontrib-applehelp ==1.0.2
  • sphinxcontrib-devhelp ==1.0.2
  • sphinxcontrib-htmlhelp ==2.0.0
  • sphinxcontrib-jsmath ==1.0.1
  • sphinxcontrib-qthelp ==1.0.3
  • sphinxcontrib-serializinghtml ==1.1.5
  • sphinxcontrib-towncrier ==0.3.1a3
  • towncrier ==22.8.0
  • typing-extensions ==3.10.0.0
  • urllib3 ==1.26.5
  • zipp ==3.4.1
tests/requirements-developer.txt pypi
  • ipython * development
  • pycmd * development
  • pyreadline * development
  • towncrier ==22.8.0 development
  • twine * development
  • wheel >0.24.0 development
tests/requirements-libraries.txt pypi
  • Django ==4.1.5 test
  • Pillow ==9.4.0 test
  • PyGObject ==3.42.2 test
  • PyQt3D ==5.15.5 test
  • PyQt5 ==5.15.7 test
  • PyQt6 ==6.4.0 test
  • PyQt6-3D ==6.4.0 test
  • PyQt6-Charts ==6.4.0 test
  • PyQt6-DataVisualization ==6.4.0 test
  • PyQt6-NetworkAuth ==6.4.0 test
  • PyQt6-QScintilla ==2.13.3 test
  • PyQt6-WebEngine ==6.4.0 test
  • PyQtChart ==5.15.6 test
  • PyQtDataVisualization ==5.15.5 test
  • PyQtNetworkAuth ==5.15.5 test
  • PyQtPurchasing ==5.15.5 test
  • PyQtWebEngine ==5.15.6 test
  • PySide2 ==5.15.2.1 test
  • PySide6 ==6.4.1 test
  • QScintilla ==2.13.3 test
  • babel ==2.11.0 test
  • future ==0.18.2 test
  • gevent ==22.10.2 test
  • importlib_resources ==5.10.2 test
  • ipython ==8.8.0 test
  • keyring ==23.0.1 test
  • keyring ==23.13.1 test
  • matplotlib ==3.6.2 test
  • numpy ==1.24.1 test
  • numpy ==1.21.5 test
  • pandas ==1.5.2 test
  • pygments ==2.14.0 test
  • python-dateutil ==2.8.2 test
  • pytz ==2022.7 test
  • requests ==2.28.1 test
  • scipy ==1.10.0 test
  • simplejson ==3.18.1 test
  • sphinx ==6.1.2 test
  • sqlalchemy ==1.4.46 test
  • zope.interface ==5.5.2 test
tests/requirements-tools.txt pypi
  • execnet >=1.5.0 test
  • flake8 * test
  • flaky * test
  • lxml * test
  • psutil * test
  • pytest >=2.7.3 test
  • pytest-drop-dup-tests * test
  • pytest-rerunfailures * test
  • pytest-timeout >=2.0.0 test
  • pytest-xdist * test
  • pywin32 * test
  • tinyaes * test