Building with PyInstaller

Use PyInstaller to package Python scripts into standalone executables.

Build on GUI

Add Build with PyInstaller, when configuring build actions. Set the parameters according to Table 1.

**Table 1** Parameters for building with PyInstaller
Parameter	Description
Action Name	Assign a custom name to the build action. The name can contain: Letters, digits, hyphens (-), underscores (_), commas (,), semicolons (;), colons (:), periods (.), slashes (/), and parentheses. 1 to 128 characters.
Tool Version	Select a tool version that matches your current development environment. For tool versions supported by CodeArts Build, see build tools and versions. If the current tools and versions do not meet your requirements, you can customize a build environment.
Commands	Configure the build and packaging commands or use the default commands, which will package the project into an executable. For more commands, see the PyInstaller official website.
Continue After Failure	Specify whether to proceed after the current action fails by setting the parameter to either Yes or No.

Build with Code

Modify the code in the BUILD block in Creating a YAML File for Your Code-based Build by referring to the following sample code:

    
         version: 2.0 # The value must be 2.0.
steps:
  BUILD:
    - python: 
        name: Build with PyInstaller
        image: cloudbuild@python3.6
        inputs: 
          command: |
            pip config set global.index-url https://pypi.org/simple
            pip config set global.trusted-host repo.xxcloud.com
            # Create a single executable file in the dist directory with -F.
            # For command details, see https://pyinstaller.readthedocs.io/en/stable/usage.html.
            pyinstaller -F  *.py
          ignore_fail: true

**Table 2** Parameters in the sample code
Parameter	Type	Description
name	String	Optional. Assign a custom name to the build action. The name can contain: Letters, digits, hyphens (-), underscores (_), commas (,), semicolons (;), colons (:), periods (.), slashes (/), and parentheses. 1 to 128 characters.
image	String	Optional. Enter the image version, which should include the fixed part cloudbuild@ and the supported Python version following it. For tool versions supported by CodeArts Build, see build tools and versions. If the current tools and versions do not meet your requirements, you can customize a build environment. The default value is cloudbuild@python3.6.
command	String	Configure the build and packaging commands or use the default commands, which will package the project into an executable. For more commands, see the PyInstaller official website.
ignore_fail	String	Whether to proceed after the current action fails. true: Yes Empty: No