add scoop package for windows and repo auth

Author: fredvisser

.github/workflows/ci.yml

@@ -21,6 +21,13 @@ jobs:
       - name: Install Poetry
         run: pip install poetry
 
+      # Configure Poetry to use NI Artifacts credentials for the private repository
+      # These secrets must be set in the GitHub repository settings
+      - name: Configure Poetry for NI Artifacts
+        run: |
+          # Poetry will use these credentials for the 'rnd-pypi-ci' source defined in pyproject.toml
+          poetry config http-basic.rnd-pypi-ci "${{ secrets.NIARTIFACTS_USER }}" "${{ secrets.NIARTIFACTS_TOKEN }}"
+
       - name: Install dependencies
         run: poetry install
 

.github/workflows/scoop.yml

@@ -0,0 +1,44 @@
+name: Scoop Windows Build
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build-scoop:
+    runs-on: windows-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install Poetry
+        run: pip install poetry
+
+      - name: Install dependencies
+        run: poetry install
+
+      - name: Build PyInstaller binary (Windows)
+        run: poetry run build-pyinstaller
+
+      - name: Build Scoop manifest
+        run: poetry run python scripts/build_scoop.py
+
+      - name: Upload Scoop manifest artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: scoop-slcli-manifest
+          path: dist/scoop-slcli.json
+
+      - name: Upload slcli.exe artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: slcli-exe
+          path: dist/slcli.exe

README.md

@@ -39,15 +39,46 @@ SystemLink Integrator CLI (slcli) is a robust, cross-platform Python CLI for Sys
   poetry run python -m slcli
   ```
 
-## Build a Standalone Binary
+## Build a Standalone Binary (Cross-Platform)
 
-To build a single-file executable using PyInstaller:
+### macOS/Linux (Homebrew/PyInstaller)
+
+To build a single-file executable and Homebrew formula:
 
 ```bash
-poetry run build-pyinstaller
+poetry run python scripts/build_homebrew.py
 ```
 
-The binary will be in the `dist/` directory.
+- This will:
+  - Build the PyInstaller binary in `dist/slcli/`
+  - Create a tarball `dist/slcli.tar.gz`
+  - Generate a Homebrew formula `dist/homebrew-slcli.rb` with the correct SHA256
+
+You can then install locally with:
+
+```bash
+brew install ./dist/homebrew-slcli.rb
+```
+
+### Windows (Scoop/PyInstaller)
+
+To build a Windows executable and Scoop manifest:
+
+```powershell
+poetry run python scripts/build_pyinstaller.py
+poetry run python scripts/build_scoop.py
+```
+
+- This will:
+  - Build `dist/slcli.exe`
+  - Generate a Scoop manifest `dist/scoop-slcli.json` with the correct SHA256
+
+You can use the manifest in your own Scoop bucket for easy installation.
+
+### CI/CD Automation
+
+- All builds, tests, and packaging are automated via GitHub Actions for both Homebrew and Scoop.
+- Artifacts (`slcli.tar.gz`, `homebrew-slcli.rb`, `slcli.exe`, `scoop-slcli.json`) are uploaded for each build.
 
 ## Testing & Linting
 

poetry.lock

@@ -29,11 +29,6 @@ pytest = ">=7.0"
 pytest-cov = ">=3.0"
 pyinstaller = "^6.14.2"
 
-[[tool.poetry.source]]
-name = "rnd-pypi-ci"
-url = "https://niartifacts.jfrog.io/artifactory/api/pypi/rnd-pypi-ci/simple"
-priority = "primary"
-
 [tool.pytest.ini_options]
 addopts = "--cov slcli --strict-markers --doctest-modules"
 

pyproject.toml

@@ -4,13 +4,16 @@
 import sys
 from pathlib import Path
 
+import toml
+
 ROOT = Path(__file__).parent.parent.resolve()
 DIST = ROOT / "dist"
 SLCLI_DIR = DIST / "slcli"
 TARBALL = DIST / "slcli.tar.gz"
 FORMULA = ROOT / "homebrew-slcli.rb"
 FORMULA_TEMPLATE = ROOT / "scripts" / "homebrew-slcli.rb.j2"
 DIST_FORMULA = DIST / "homebrew-slcli.rb"
+PYPROJECT = ROOT / "pyproject.toml"
 
 
 def run(cmd, **kwargs):
@@ -19,6 +22,12 @@ def run(cmd, **kwargs):
     subprocess.run(cmd, check=True, **kwargs)
 
 
+def get_version():
+    """Extract the version from pyproject.toml."""
+    data = toml.load(PYPROJECT)
+    return data["tool"]["poetry"]["version"]
+
+
 def build_pyinstaller():
     """Build the PyInstaller binary using Poetry."""
     run(["poetry", "run", "python", str(ROOT / "scripts" / "build_pyinstaller.py")])
@@ -43,13 +52,13 @@ def compute_sha256():
     return sha256
 
 
-def render_formula(sha256):
+def render_formula(sha256, version):
     """Render the Homebrew formula from the template and write to dist/homebrew-slcli.rb."""
     if not FORMULA_TEMPLATE.exists():
         print(f"Error: {FORMULA_TEMPLATE} not found.")
         sys.exit(1)
     template = FORMULA_TEMPLATE.read_text()
-    rendered = template.replace("{{ sha256 }}", sha256)
+    rendered = template.replace("{{ sha256 }}", sha256).replace("{{ version }}", version)
     DIST_FORMULA.write_text(rendered)
     print(f"Wrote Homebrew formula to {DIST_FORMULA}")
 
@@ -72,10 +81,11 @@ def update_formula(sha256):
 
 def main():
     """Build, package, and update the Homebrew formula for slcli."""
+    version = get_version()
     build_pyinstaller()
     create_tarball()
     sha256 = compute_sha256()
-    render_formula(sha256)
+    render_formula(sha256, version)
     update_formula(sha256)
     print("Homebrew tarball build complete.")
 

scripts/build_homebrew.py

@@ -0,0 +1,70 @@
+"""Builds a Scoop manifest for the slcli Windows binary and writes it to dist/scoop-slcli.json."""
+
+import subprocess
+import sys
+from pathlib import Path
+
+import toml
+
+ROOT = Path(__file__).parent.parent.resolve()
+DIST = ROOT / "dist"
+SLCLI_EXE = DIST / "slcli.exe"
+MANIFEST_TEMPLATE = ROOT / "scripts" / "scoop-slcli.json.j2"
+DIST_MANIFEST = DIST / "scoop-slcli.json"
+PYPROJECT = ROOT / "pyproject.toml"
+
+
+def run(cmd, **kwargs):
+    """Run a shell command and print it."""
+    print(f"$ {' '.join(cmd) if isinstance(cmd, list) else cmd}")
+    subprocess.run(cmd, check=True, **kwargs)
+
+
+def compute_sha256():
+    """Compute the SHA256 checksum of the slcli.exe binary."""
+    result = subprocess.run(
+        [
+            "powershell",
+            "-Command",
+            f"Get-FileHash -Algorithm SHA256 '{SLCLI_EXE}' | Select-Object -ExpandProperty Hash",
+        ],
+        capture_output=True,
+        text=True,
+    )
+    sha256 = result.stdout.strip()
+    print(f"SHA256 for Scoop manifest: {sha256}")
+    return sha256
+
+
+def get_version():
+    """Extract the version from pyproject.toml."""
+    data = toml.load(PYPROJECT)
+    return data["tool"]["poetry"]["version"]
+
+
+def render_manifest(version, url, sha256):
+    """Render the Scoop manifest from the template and write to dist/scoop-slcli.json."""
+    if not MANIFEST_TEMPLATE.exists():
+        print(f"Error: {MANIFEST_TEMPLATE} not found.")
+        sys.exit(1)
+    template = MANIFEST_TEMPLATE.read_text()
+    rendered = (
+        template.replace("{{ version }}", version)
+        .replace("{{ url }}", url)
+        .replace("{{ sha256 }}", sha256)
+    )
+    DIST_MANIFEST.write_text(rendered)
+    print(f"Wrote Scoop manifest to {DIST_MANIFEST}")
+
+
+def main():
+    """Build and render the Scoop manifest for slcli."""
+    version = get_version()
+    url = f"https://github.com/ni/systemlink-cli/releases/download/v{version}/slcli.exe"
+    sha256 = compute_sha256()
+    render_manifest(version, url, sha256)
+    print("Scoop manifest build complete.")
+
+
+if __name__ == "__main__":
+    main()

scripts/build_scoop.py

@@ -2,7 +2,7 @@ class HomebrewSlcli < Formula
   desc "SystemLink Integrator CLI: Manage SystemLink test plan templates and workflows"
   homepage "https://github.com/ni/systemlink-cli"
   url "file://#{Dir.pwd}/dist/slcli.tar.gz"
-  version "1.0.0"
+  version "{{ version }}"
   sha256 "{{ sha256 }}"
   license "MIT"
 

scripts/homebrew-slcli.rb.j2

@@ -0,0 +1,23 @@
+{
+    "version": "{{ version }}",
+    "description": "SystemLink Integrator CLI",
+    "homepage": "https://github.com/ni/systemlink-cli",
+    "license": "MIT",
+    "architecture": {
+        "64bit": {
+            "url": "{{ url }}",
+            "hash": "{{ sha256 }}"
+        }
+    },
+    "bin": "slcli.exe",
+    "checkver": {
+        "github": "https://github.com/ni/systemlink-cli"
+    },
+    "autoupdate": {
+        "architecture": {
+            "64bit": {
+                "url": "https://github.com/ni/systemlink-cli/releases/download/v$version/slcli.exe"
+            }
+        }
+    }
+}