Refactor entry points and move meson, ninja to dev-dependencies, improve build time

Author: Tremeschin

.github/funding.yml

@@ -19,20 +19,23 @@ jobs:
         uses: astral-sh/setup-uv@v3
 
       - name: Get options
-        run: uv run nvibrant-actions >> $GITHUB_ENV
+        run: uv run nvibrant/version.py >> $GITHUB_ENV
         shell: bash
 
       - name: Compile
-        run: uv run nvibrant-build
+        run: uv run nvibrant/build.py
 
       - name: Build wheel
         run: uv build --wheel -o dist
 
-      - name: Publish to PyPI
-        run: uv publish dist/*.whl
+      # - name: Publish to PyPI
+      #   run: uv publish dist/*.whl
 
       - name: Compress binaries
-        run: tar --transform='s|^nvibrant/resources/|nvibrant/|' -czf dist/binaries.tar.gz nvibrant/resources/*.bin
+        run: |
+          tar --transform='s|^nvibrant/resources/|nvibrant/|' \
+              -czf dist/nvibrant-${{env.GHA_VERSION}}-bin.tar.gz \
+              nvibrant/resources/*.bin
 
       - name: Upload artifacts
         uses: actions/upload-artifact@v4

.github/workflows/release.yml

@@ -1,4 +1,5 @@
-build
-release
-nvibrant/resources
 *.pyc
+
+# Prebuilt binaries
+nvibrant/resources
+build

.gitignore

@@ -1,6 +1,4 @@
-project('nvibrant', 'cpp',
-  version: run_command('nvibrant/version.py', check: true).stdout().strip()
-)
+project('nvibrant', 'cpp', version: '1.0.0')
 
 # Paths to nvidia sources and headers
 nvidia_src     = 'open-gpu/src'

meson.build

@@ -1 +1,66 @@
+import os
+import shutil
+import subprocess
+import sys
+from pathlib import Path
+
 from nvibrant.version import __version__
+
+# Common paths
+PACKAGE   = Path(__file__).parent
+NVIBRANT  = (PACKAGE.parent)
+RESOURCES = (PACKAGE/"resources")
+OPEN_GPU  = (NVIBRANT/"open-gpu")
+RELEASE   = (NVIBRANT/"release")
+BUILD     = (NVIBRANT/"build")
+
+# Common tools
+PYTHON = (sys.executable,)
+MESON  = (*PYTHON, "-m", "mesonbuild.mesonmain")
+NINJA  = (*PYTHON, "-m", "ninja")
+
+# # Subprocess
+
+def shell(*command: str, echo: bool=True, **kwargs) -> subprocess.CompletedProcess:
+    command = tuple(map(str, command))
+    if echo: print(f"• Call {command}")
+    return subprocess.run(command, **kwargs)
+
+# # Repositories
+
+def get_tags(repo: Path) -> list[str]:
+    return list(filter(None,
+        subprocess.check_output(("git", "tag"), cwd=repo)
+    .decode("utf-8").splitlines()))
+
+def checkout_tag(repo: Path, tag: str) -> subprocess.CompletedProcess:
+    return shell("git", "checkout", "-f", tag, cwd=repo)
+
+# # Directories
+
+def mkdir(path: Path) -> Path:
+    Path(path).mkdir(parents=True, exist_ok=True)
+    return Path(path)
+
+def rmdir(path: Path) -> Path:
+    shutil.rmtree(path, ignore_errors=True)
+    return Path(path)
+
+def rsdir(path: Path) -> Path:
+    return mkdir(rmdir(path))
+
+# # Drivers
+
+def current_driver() -> str:
+
+    # Safety fallback or override with environment variable
+    if (force := os.getenv("NVIDIA_DRIVER_VERSION")):
+        return force
+
+    # Seems to be a common and stable path to get the information
+    elif (file := Path("/sys/module/nvidia/version")).exists():
+        return file.read_text("utf8").strip()
+
+    print("Could not find the current driver version at /sys/module/nvidia/version")
+    print("• Run with 'NVIDIA_DRIVER_VERSION=x.y.z nvibrant' to set or force it")
+    sys.exit(1)

nvibrant/__init__.py

@@ -1,106 +1,12 @@
-import os
-import shutil
-import subprocess
 import sys
-from pathlib import Path
 
-from nvibrant import __version__
+from nvibrant import (
+    RESOURCES,
+    __version__,
+    current_driver,
+    shell,
+)
 
-# Common paths
-PACKAGE   = Path(__file__).parent
-NVIBRANT  = (PACKAGE.parent)
-RESOURCES = (PACKAGE/"resources")
-OPEN_GPU  = (NVIBRANT/"open-gpu")
-RELEASE   = (NVIBRANT/"release")
-BUILD     = (NVIBRANT/"build")
-
-# Common tools
-PYTHON = (sys.executable,)
-MESON  = (*PYTHON, "-m", "mesonbuild.mesonmain")
-NINJA  = (*PYTHON, "-m", "ninja")
-
-# #
-
-def shell(*command: str, echo: bool=True, **kwargs) -> subprocess.CompletedProcess:
-    command = tuple(map(str, command))
-    if echo: print(f"• Call {command}")
-    return subprocess.run(command, **kwargs)
-
-# # Repositories
-
-def get_tags(repo: Path) -> list[str]:
-    return list(filter(None,
-        subprocess.check_output(("git", "tag"), cwd=repo)
-    .decode("utf-8").splitlines()))
-
-def checkout_tag(repo: Path, tag: str) -> subprocess.CompletedProcess:
-    return shell("git", "checkout", "-f", tag, cwd=repo)
-
-# # Directories
-
-def mkdir(path: Path) -> Path:
-    Path(path).mkdir(parents=True, exist_ok=True)
-    return Path(path)
-
-def rmdir(path: Path) -> Path:
-    shutil.rmtree(path, ignore_errors=True)
-    return Path(path)
-
-def reset_dir(path: Path) -> Path:
-    return mkdir(rmdir(path))
-
-# # Drivers
-
-def current_driver() -> str:
-
-    # Safety fallback or override with environment variable
-    if (force := os.getenv("NVIDIA_DRIVER_VERSION")):
-        return force
-
-    # Seems to be a common and stable path to get the information
-    elif (file := Path("/sys/module/nvidia/version")).exists():
-        return file.read_text("utf8").strip()
-
-    print("Could not find the current driver version at /sys/module/nvidia/version")
-    print("• Run with 'NVIDIA_DRIVER_VERSION=x.y.z nvibrant' to set or force it")
-    sys.exit(1)
-
-# ------------------------------------------------------------------------------------------------ #
-# Entry points
-
-def actions() -> None:
-    for (key, value) in dict(
-        GHA_VERSION=__version__,
-    ).items():
-        print(f"{key}={value}")
-
-def build() -> None:
-    mkdir(RESOURCES)
-
-    # Internal structs may differ between versions,
-    # compile the project for all nvidia drivers
-    for driver in reversed(get_tags(OPEN_GPU)):
-        checkout_tag(OPEN_GPU, driver)
-
-        # Configure and compile cpp project
-        shell(*MESON, "setup", BUILD,
-            "--buildtype", "release",
-            "--reconfigure")
-        shell(*NINJA, "-C", BUILD)
-
-        # Name the binary release
-        nvibrant = (BUILD/"nvibrant")
-        nvibrant.rename(RESOURCES / (
-            f"nvibrant"
-            f"-linux"
-            f"-amd64"
-            f"-{driver}"
-            f"-v{__version__}"
-            f".bin"
-        ))
-
-    # Revert back to the main branch
-    checkout_tag(OPEN_GPU, "main")
 
 def main() -> None:
     driver = current_driver()
@@ -127,5 +33,6 @@ def main() -> None:
     shell("chmod", "+x", nvibrant, echo=False)
     shell(nvibrant, *sys.argv[1:], echo=False)
 
-if __name__ == "__main__":
+
+if (__name__ == "__main__"):
     main()

nvibrant/__main__.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+from nvibrant import (
+    BUILD,
+    MESON,
+    NINJA,
+    OPEN_GPU,
+    RESOURCES,
+    __version__,
+    checkout_tag,
+    get_tags,
+    rsdir,
+    shell,
+)
+
+
+def build() -> None:
+    rsdir(RESOURCES)
+
+    # Configure the project once
+    shell(*MESON, "setup", BUILD,
+        "--buildtype", "release",
+        "--reconfigure")
+
+    # Internal structs may differ between versions,
+    # compile the project for all nvidia drivers
+    for driver in reversed(get_tags(OPEN_GPU)):
+        checkout_tag(OPEN_GPU, driver)
+        shell(*NINJA, "-C", BUILD)
+
+        # Name the binary release
+        nvibrant = (BUILD/"nvibrant")
+        nvibrant.rename(RESOURCES / (
+            f"nvibrant"
+            f"-linux"
+            f"-amd64"
+            f"-{driver}"
+            f"-v{__version__}"
+            f".bin"
+        ))
+
+    # Revert back to the main branch
+    checkout_tag(OPEN_GPU, "main")
+
+if (__name__ == "__main__"):
+    build()

nvibrant/build.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python3
-
-__version__ = "1.0.3"
+__version__ = "1.0.4"
 
 if (__name__ == "__main__"):
-    print(__version__)
+    print(f"GHA_VERSION={__version__}")

nvibrant/version.py

@@ -1,3 +1,6 @@
+[tool.hatch.version]
+path = "nvibrant/version.py"
+
 [project]
 name        = "nvibrant"
 description = "🟢 Nvidia Digital Vibrance on Wayland"
@@ -6,29 +9,28 @@ dynamic     = ["version"]
 readme      = "readme.md"
 license     = "GPL-3.0"
 requires-python = ">=3.9"
-dependencies = [
-    "meson~=1.7.0",
-    "ninja~=1.11.1.4",
-]
+dependencies = []
 
 [project.scripts]
-nvibrant-actions = "nvibrant.__main__:actions"
-nvibrant-build   = "nvibrant.__main__:build"
-nvibrant         = "nvibrant.__main__:main"
+nvibrant = "nvibrant.__main__:main"
+
+[tool.uv]
+dev-dependencies = [
+    "meson~=1.7.2",
+    "ninja~=1.11.1.4",
+]
 
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
-[tool.hatch.version]
-path = "nvibrant/version.py"
-
 [tool.hatch.build.targets.wheel]
 packages = ["nvibrant"]
 ignore-vcs = true
 
 [tool.hatch.build.targets.sdist]
-exclude = ["*"]
+exclude = ["open-gpu"]
+ignore-vcs = true
 
 [tool.hatch.build]
 exclude = ["main.cpp"]