👷 [+build] Building binaries as a part of CI (#13)

Author: davidbrownell

.github/actions/release_impl/action.yml

@@ -36,11 +36,15 @@ runs:
       with:
         enable-cache: false # No uv.lock or requirements.txt files, so nothing to cache on
 
-    - name: Download Python Package
+    - name: Download Artifacts
       uses: actions/download-artifact@v4
       with:
-        name: Python package
         path: dist
+        merge-multiple: true
+
+    - name: Remove Coverage Files Artifacts
+      shell: bash
+      run: rm dist/.coverage*
 
     # Create repository tag
     - name: Create Repository Tag

.github/workflows/CICD_impl.yml

@@ -222,9 +222,91 @@ jobs:
       - name: Validate Python Package
         run: uv run python -c "import FileBackup as package; assert package.__version__ == '${{ env.PACKAGE_VERSION }}', package.__version__"
 
+  # ----------------------------------------------------------------------
+  build_binary:
+    needs: python_package
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        os: ${{ fromJson(inputs.operating_system_json_string) }}
+
+    name: Build Stand Alone Binary
+    runs-on: ${{ matrix.os }}
+
+    env:
+      PACKAGE_VERSION: ${{ needs.python_package.outputs.package_version }}
+
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and python
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ inputs.python_package_version }}
+          enable-cache: true
+
+      - name: Build Binary
+        run: uv run python BuildBinary.py Build --verbose
+
+      - name: Bundle Binary
+        run: uv run python BuildBinary.py Bundle --custom-filename-suffix "-${{ env.PACKAGE_VERSION }}.${{ matrix.os }}" --verbose
+
+      - name: Upload Bundle
+        uses: actions/upload-artifact@v4
+        with:
+          name: Binary.${{ matrix.os }}
+          path: FileBackup-${{ env.PACKAGE_VERSION }}.*
+  validate_binary:
+    needs: [python_package, build_binary]
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        os: ${{ fromJson(inputs.operating_system_json_string) }}
+
+    name: Validate Stand Alone Binary
+    runs-on: ${{ matrix.os }}
+
+    env:
+      PACKAGE_VERSION: ${{ needs.python_package.outputs.package_version }}
+
+    permissions: {}
+
+    steps:
+      - name: Download Binary
+        uses: actions/download-artifact@v4
+        with:
+          name: Binary.${{ matrix.os }}
+          path: binary
+
+      - name: Unzip Archive (Windows)
+        if: ${{ startsWith(matrix.os, 'windows') }}
+        run: |-
+          cd binary
+          tar -xf FileBackup-${{ env.PACKAGE_VERSION }}.windows.zip
+
+      - name: Unzip Archive (Not Windows)
+        if: ${{ !startsWith(matrix.os, 'windows') }}
+        run: |-
+          cd binary
+
+          for file in ./*
+          do
+            tar -xvzf "$file"
+          done
+
+      - name: Validate Binary
+        run: binary/FileBackup version
+
   # ----------------------------------------------------------------------
   release:
-    needs: [package_coverage, python_package, validate_python_package]
+    needs: [package_coverage, python_package, validate_python_package, validate_binary]
 
     name: Release
     runs-on: ubuntu-latest

.gitignore

@@ -4,3 +4,4 @@
 __pycache__
 minisign_key.pri
 post_generation_instructions.html
+build/

BuildBinary.py

@@ -0,0 +1,120 @@
+import os
+import shutil
+
+from pathlib import Path
+from typing import Annotated, Optional
+
+import typer
+
+from dbrownell_Common import SubprocessEx
+from dbrownell_Common.Streams.DoneManager import DoneManager, Flags as DoneManagerFlags
+from typer.core import TyperGroup
+
+
+# ----------------------------------------------------------------------
+class NaturalOrderGrouper(TyperGroup):
+    # pylint: disable=missing-class-docstring
+    # ----------------------------------------------------------------------
+    def list_commands(self, *args, **kwargs):  # pylint: disable=unused-argument
+        return self.commands.keys()
+
+
+# ----------------------------------------------------------------------
+app = typer.Typer(
+    cls=NaturalOrderGrouper,
+    help=__doc__,
+    no_args_is_help=True,
+    pretty_exceptions_show_locals=False,
+    pretty_exceptions_enable=False,
+)
+
+
+# ----------------------------------------------------------------------
+@app.command("Build", no_args_is_help=False)
+def Build(
+    verbose: Annotated[
+        bool,
+        typer.Option("--verbose", help="Write verbose information to the terminal."),
+    ] = False,
+    debug: Annotated[
+        bool,
+        typer.Option("--debug", help="Write debug information to the terminal."),
+    ] = False,
+) -> None:
+    """Build a standalone binary for the application."""
+
+    with DoneManager.CreateCommandLine(
+        flags=DoneManagerFlags.Create(verbose=verbose, debug=debug),
+    ) as dm:
+        command_line = "cxfreeze --script src/FileBackup/CommandLine/EntryPoint.py --target-name=FileBackup"
+
+        dm.WriteVerbose(f"Command line: {command_line}\n\n")
+
+        with dm.YieldStream() as stream:
+            dm.result = SubprocessEx.Stream(command_line, stream)
+
+
+# ----------------------------------------------------------------------
+@app.command("Bundle", no_args_is_help=False)
+def Bundle(
+    custom_filename_suffix: Annotated[
+        Optional[str],
+        typer.Option("--custom-filename-suffix", help="Custom suffix for the output filename."),
+    ] = None,
+    verbose: Annotated[
+        bool,
+        typer.Option("--verbose", help="Write verbose information to the terminal."),
+    ] = False,
+    debug: Annotated[
+        bool,
+        typer.Option("--debug", help="Write debug information to the terminal."),
+    ] = False,
+) -> None:
+    """Bundle a previously built standalone binary."""
+
+    custom_filename_suffix = (custom_filename_suffix or "").removesuffix("-latest")
+
+    with DoneManager.CreateCommandLine(
+        flags=DoneManagerFlags.Create(verbose=verbose, debug=debug),
+    ) as dm:
+        build_dir = Path(__file__).parent / "build"
+
+        if not build_dir.is_dir():
+            dm.WriteError(
+                f"The build directory '{build_dir}' does not exist. Please run the 'Build' command first.\n"
+            )
+            return
+
+        subdirs = list(build_dir.iterdir())
+        if len(subdirs) != 1 or not subdirs[0].is_dir():
+            dm.WriteError(
+                f"The build directory '{build_dir}' should contain exactly one subdirectory with the built binary and its dependencies.\n"
+            )
+            return
+
+        build_dir /= subdirs[0]
+
+        output_name = f"FileBackup{custom_filename_suffix or ''}"
+
+        if os.name == "nt":
+            output_filename = Path(f"{output_name}.zip")
+            format = "zip"
+        else:
+            output_filename = Path(f"{output_name}.tar.gz")
+            format = "gztar"
+
+        with dm.Nested(f"Creating '{output_filename.name}'..."):
+            output_filename.unlink(missing_ok=True)
+
+            shutil.make_archive(
+                output_name,
+                format,
+                root_dir=build_dir,
+            )
+
+
+# ----------------------------------------------------------------------
+# ----------------------------------------------------------------------
+# ----------------------------------------------------------------------
+if __name__ == "__main__":
+    app()

pyproject.toml

@@ -20,13 +20,14 @@ keywords = [
     "restore",
 ]
 
+license = "MIT"
+
 classifiers = [
     "Development Status :: 4 - Beta",  # TODO
     "Environment :: Console",
     "Intended Audience :: Developers",
     "Intended Audience :: End Users/Desktop",
     "Intended Audience :: System Administrators",
-    "License :: OSI Approved :: MIT License",
     "Natural Language :: English",
     "Operating System :: MacOS",
     "Operating System :: Microsoft :: Windows",
@@ -42,9 +43,6 @@ classifiers = [
     "Topic :: Utilities",
 ]
 
-[project.license]
-text = "MIT"
-
 [project.urls]
 Homepage = "https://github.com/davidbrownell/FileBackup"
 Documentation = "https://github.com/davidbrownell/FileBackup"
@@ -61,6 +59,8 @@ build-backend = "hatchling.build"
 [dependency-groups]
 dev = [
     "autogitsemver>=0.8.0",
+    "cx-freeze>=8.3.0",
+    "dbrownell-commitemojis>=0.1.3",
     "pre-commit>=4.2.0",
     "pytest>=8.3.5",
     "pytest-cov>=6.1.1",