PyAppify Action

This GitHub Action uses PyAppify to compile and package your Python application into cross-platform, standalone executables directly within your workflow.

Prerequisites

Before using this action, you must have a pyappify.yml configuration file in the root of your repository. You may also include an optional icons directory for custom application icons.

• pyappify.yml
• icons
  • icon.ico
  • icon.png

pyappify.yml

This file defines your application's name and its build profiles.

Example pyappify.yml:

name: "pyappify-sample" # English only
profiles:
  - name: "release_正式版" # can use Unicode chars
    git_url: "https://github.com/ok-oldking/pyappify-action.git" # the repo url to clone, must have tags for the version management, semver is recommended
    main_script: "main.py" # if ending with .py will use python venv to run, else will search in the working dir and the venv's Script/bin path
    requires_python: "3.12" # supports python 3.7 - 3.13
    requirements: "requirements.txt"  # support using a *.txt or pyproject.toml's .[dev,docs]
    pip_args: "--index-url https://mirrors.cloud.tencent.com/pypi/simple" # optional

  - name: "debug" # can use Unicode chars
    main_script: "main_debug.py" # you can omit other properties, will use the first profile's as default
    pip_args: "-i https://mirrors.aliyun.com/pypi/simple" # optional

Inputs

Input	Description	Default	Required
version	The tag version of pyappify to use (e.g., v0.1.0). It is highly recommended to pin a version for consistency. You can checkout the versions at https://github.com/ok-oldking/pyappify/releases	latest tag	false

Usage Example

This example demonstrates how to build your application on Windows, macOS, and Ubuntu(Currently only support windows), and then release the resulting packages.

name: Build Application

on:
  push:
    tags:
      - 'v*'

jobs:
  build:
    strategy:
      matrix:
        platform: [windows-latest] # will support ubuntu-latest, macos-latest in the future
    runs-on: ${{ matrix.platform }}

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      
      - name: Build with PyAppify Action
        id: build-app
        uses: ok-oldking/pyappify-action@master
        with:
          version: 'v0.1.0' # Optional: Pin the PyAppify version, you can checkout the version at https://github.com/ok-oldking/pyappify/releases
          use_release: 'https://api.github.com/repos/ok-oldking/pyappify-action/releases/tags/v1.0.0' # Optional: Use a existing release's assets to skip the building process, use when you didn't change the icons and the pyappify.yml

      - name: Release
        uses: softprops/action-gh-release@v2
        if: startsWith(github.ref, 'refs/tags/')
        with:
          body: | 
            Your Release Note
          files: pyappify_dist/*

How It Works

The action automates the following steps:

1. Clones the PyAppify repository.
2. Reads your local pyappify.yml to get your application's name and build profiles.
3. Copies your configuration and icons directory into the PyAppify source tree.
4. Updates the PyAppify project files with your application's name.
5. Builds the application binary using Tauri.
6. Packages the final application, creating a separate zipped bundle for each profile defined in your configuration file.
7. Outputs the path to the directory containing the generated artifacts.