pynsist 1.0

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, or Python 2.7.

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/
    
See The Config File for more details about this.
  1. Run pynsist installer.cfg to generate your installer. If pynsist isn’t found, you can use python -m nsist installer.cfg instead.

Contents

See also the examples folder in the repository.

The API is not yet documented here, because I’m still working out how it should be structured. The functions and classes have docstrings, and you’re welcome to use them directly, though they may change in the future.

Indices and tables