The Configurator is the GUI/CUI used to create a project configuration. It is broken down into three sections: Setup, Update, and Launch.

Setup

Setup installs your project’s dependencies and has 3 variables:

Python Version: The Python version your project was written in. It is formatted as follows: #.#.#
If your project uses Python 3.10, you would provide ‘3.10’

Minimum Python Version: The minimum Python version your project supports, it follows the same formatting as above. If left blank, it will be the same as Python Version

Packages: The packages your project depends on. A package has two values, pypiName and importName.
pypiName is the name used to install the package using pip.
importName is the name used to import the package.
If your package has a different importName than pypiName, use this format: ‘pypiName:importName’ [example: pyyaml:yaml]
If the names are the same, provide the name [example: numpy]

Update

Update checks GitHub for updates and downloads/installs them. It has 7 variables:

Organization: Your GitHub username/organization [example: daavofficial]

Repository: The GitHub repository [example: Project-Management]

Branch: The GitHub branch [example: main]

Version Path: The path to the file containing the version [example: /src/config/config.py]

Find: The string to find in that file: [example: VERSION = ]

Token: GitHub token used for private repositories. Leave blank otherwise

Skip Update checking: If checked, the Frontend will not check for updates

Launch

Launch locates the python executable using your Python Version, and catches errors. It has 4 variables:

Project Root: The relative path from pyLaunch to your project’s root [example: ..]

Project Main: The path to your project’s main file [example: /src/main.py]

Error Codes: The error codes to catch when your project exits. An error code has two values: code and arguments.
code is the number to check for on exit [example: -1]
arguments are the arguments to send to your main file if it’s code was found [example: -UI GUI]
The code must be a number, and must be provided in this format: code:arguments
If you provide a code and no arguments, your project will reload (useful for development)
If your project exits without code 0, or one in your error codes, a prompt will be shown asking to reload the project, and will provide the URL to your project’s GitHub issues page.

Skip Error checking: If checked, no exit codes will be checked, and pyLaunch (and your project) will close