setup.py

from ctypes.util import find_library
import pathlib
import re
import setuptools
import sys

path = pathlib.Path(__file__).absolute().parent


# Main metadata
name = "F95Checker"
identifier = "io.github.willy-jl.f95checker"
icon = path / "resources/icons/icon"
script = path / "main.py"
debug_script = path / "main-debug.py"
version = str(re.search(rb'version = "(\S+)"', script.read_bytes()).group(1), encoding="utf-8")
debug_script.write_bytes(re.sub(rb"debug = .*", rb"debug = True", script.read_bytes()))  # Generate debug script

# Friendly reminder
try:
    import cx_Freeze
    import cx_Freeze.hooks
except ModuleNotFoundError:
    print("cx_Freeze is not installed! Run: pip install -r requirements-dev.txt")
    sys.exit(1)

# Build configuration
includes = []
excludes = ["tkinter"]
packages = ["OpenGL"]
platform_packages = {
    "linux": ["dbus_fast"],
}
constants = []
bin_includes = []
bin_excludes = []
platform_libs = {
    "linux": [
        "!EGL",
        "bz2",
        "crypto",
        "ffi",
        "sqlite3",
        "ssl",
        "xcb-cursor",
    ],
    "darwin": ["intl"],
}
include_files = [
    (path / "browser/chrome.zip",    "browser/chrome.zip"),
    (path / "browser/firefox.zip",   "browser/firefox.zip"),
    (path / "browser/integrated.js", "browser/integrated.js"),
    (path / "resources/",            "resources/"),
    (path / "LICENSE",               "LICENSE"),
]
platform_qt_plugins = {
    "linux": [
        "wayland-decoration-client",
        "wayland-graphics-integration-client",
        "wayland-shell-integration",
    ],
}
zip_include_files = []
zip_include_packages = "*"
zip_exclude_packages = [
    "bencode2",
    "desktop_notifier",
    "glfw",
] + (["PyQt6"] if sys.platform.startswith("win") else [])
optimize = 2
silent_level = 0
include_msvcr = True


# Add correct icon extension
if sys.platform.startswith("win"):
    icon = f"{icon}.ico"
elif sys.platform.startswith("darwin"):
    icon = f"{icon}.icns"
else:
    icon = f"{icon}.png"


# Bundle packages
for platform, pkgs in platform_packages.items():
    if sys.platform.startswith(platform):
        for pkg in pkgs:
            packages.append(pkg)


# Bundle system libraries
for platform, libs in platform_libs.items():
    if sys.platform.startswith(platform):
        for lib in libs:
            if lib.startswith("!"):
                lib = lib.removeprefix("!")
                bin_list = bin_excludes
            else:
                bin_list = bin_includes
            if lib_path := find_library(lib):
                bin_list.append(lib_path)


# Bundle Qt plugins
for platform, plugins in platform_qt_plugins.items():
    if sys.platform.startswith(platform):
        for plugin in plugins:
            include_files += cx_Freeze.hooks.get_qt_plugins_paths("PyQt6", plugin)


# Browser extension packager command
class BrowserExtension(setuptools.Command):
    """Build browser extension packages."""

    command_name = "browser"
    user_options = []

    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def run(self):
        from external import ziparch
        browser = path / "browser"
        mdi_webfont = next(path.glob("resources/fonts/materialdesignicons-webfont.*.ttf")).read_bytes()

        chrome_src = browser / "chrome"
        (chrome_src / "fonts/mdi-webfont.ttf").write_bytes(mdi_webfont)
        chrome_zip = browser / ("chrome" + ziparch.ZIP_ARCH_EXTENSION)
        ziparch.compress_tree_ziparch(str(chrome_src), str(chrome_zip), gz_level=0)

        firefox_src = browser / "firefox"
        (firefox_src / "fonts/mdi-webfont.ttf").write_bytes(mdi_webfont)
        firefox_zip = browser / ("firefox" + ziparch.ZIP_ARCH_EXTENSION)
        ziparch.compress_tree_ziparch(str(firefox_src), str(firefox_zip), gz_level=0)


# Actual build
cx_Freeze.setup(
    name=name,
    version=version,
    executables=[
        cx_Freeze.Executable(
            script=script,
            base="gui",
            target_name=name,
            icon=icon,
        ),
        cx_Freeze.Executable(
            script=debug_script,
            base="console",
            target_name=name + "-Debug",
            icon=icon,
        ),
    ],
    options={
        "build_exe": {
            "includes": includes,
            "excludes": excludes,
            "packages": packages,
            "constants": constants,
            "bin_includes": bin_includes,
            "bin_excludes": bin_excludes,
            "include_files": include_files,
            "zip_includes": zip_include_files,
            "zip_include_packages": zip_include_packages,
            "zip_exclude_packages": zip_exclude_packages,
            "optimize": optimize,
            "silent_level": silent_level,
            "include_msvcr": include_msvcr,
        },
        "bdist_mac": {
            "iconfile": icon,
            "bundle_name": name,
            "plist_items": [
                ("CFBundleName", name),
                ("CFBundleDisplayName", name),
                ("CFBundleIdentifier", identifier),
                ("CFBundleVersion", version),
                ("CFBundlePackageType", "APPL"),
                ("CFBundleSignature", "????"),
            ],
        },
    },
    py_modules=[],
    cmdclass={
        "browser": BrowserExtension,
        "extension": BrowserExtension,
    },
)