Skip to main content
2025 Python Packaging Survey is now live!  Take the survey now

Build Windows installers for Python apps

Project description

pynsist is a tool to build Windows installers for your Python applications. The installers bundle Python itself, so you can distribute your application to people who don’t have Python installed.

At present, pynsist requires Python 3.3 or above.

For more information, see the documentation and the examples.

Quickstart

  1. Get the tools. Install NSIS, and then install pynsist from PyPI by running pip install pynsist.

  2. Write a config file installer.cfg, like this:

    [Application]
    name=My App
    version=1.0
    # How to launch the app - this calls the 'main' function from the 'myapp' package:
    entry_point=myapp:main
    icon=myapp.ico
    
    [Python]
    version=3.4.0
    
    [Include]
    # Importable packages that your application requires, one per line
    packages = requests
         bs4
         html5lib
    
    # Other files and folders that should be installed
    files = LICENSE
        data_files/
  3. Run pynsist installer.cfg to generate your installer. If pynsist isn’t found, you can use python -m nsist installer.cfg instead.

Supported by

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