Rework environment setup

.github/workflows/checks.yml

@@ -9,32 +9,15 @@ on:
       - main
 
 jobs:
-  python_format:
+  code_formatting:
     runs-on: ubuntu-24.04
     container:
-      image: rootproject/root:6.32.00-ubuntu24.04
-      options: --user 0 # run as root
-
+      image: tvoigtlaender/kingmaker_standalone:V1.5
+      options: --user 0
     steps:
-      - uses: actions/checkout@v3
-
-      - name: apt update
-        run: apt-get -y update
-
-      - name: Install missing software
-        run: apt-get install -y git python3-pip python3-venv
-
-      - name: Create venv
-        shell: bash
-        run: |
-          cd $GITHUB_WORKSPACE
-          python3 -m venv venv
-          source venv/bin/activate
-          pip install black==24.4.2
-
-      - name: Check Python formatting
-        shell: bash
+      - name: Clone project
+        uses: actions/checkout@v4
+      - name: Run all formatting checks
         run: |
-          cd $GITHUB_WORKSPACE
-          source venv/bin/activate
-          bash scripts/python-formatting.sh
+          git config --global --add safe.directory '*'
+          bash ./checks/python-formatting.sh

.gitignore

@@ -8,13 +8,12 @@ tarballs/
 workdir/
 logs/
 *.tar.gz
-*.txt
 miniconda/
 miniforge/
 quantities_map/
 output/
-CROWN/
 .nfs*
+*.txt
 
 #luigid pickle
 luigid_state.pickle
@@ -34,6 +33,7 @@ dist/
 downloads/
 eggs/
 .eggs/
+.conda/
 lib/
 lib64/
 parts/

.gitmodules

@@ -4,6 +4,6 @@
 [submodule "sample_database"]
 	path = sample_database
 	url = [email protected]:KIT-CMS/KingMaker_sample_database.git
-[submodule "kingmaker-images"]
-	path = kingmaker-images
-	url = git@github.com:KIT-CMS/kingmaker-images.git
+[submodule "CROWN"]
+	path = CROWN
+	url = https://github.com/KIT-CMS/CROWN.git

README.md

@@ -1,8 +1,13 @@
 # KingMaker
 
-
-[![Analysis Containers](https://github.com/KIT-CMS/kingmaker-images/actions/workflows/deploy-base-images.yml/badge.svg?branch=main)](https://github.com/KIT-CMS/kingmaker-images/actions/workflows/deploy-base-images.yml)
-
 KingMaker is the workflow management for producing ntuples with the [CROWN](https://github.com/KIT-CMS/CROWN) framework. The workflow management is based on [law](https://github.com/riga/law), which is using [luigi](https://github.com/spotify/luigi) as backend.
 
 **⚠ Important: A detailed description of the KingMaker workflow to produce NTuples can be found in the [CROWN documentation](https://crown.readthedocs.io/en/latest/kingmaker.html#).**
+
+
+## 🛠 Infrastructure & Containers
+
+KingMaker can runs within container environments to ensure reproducibility.
+
+* **Container Images and Environments**: Dockerfiles and Conda environment specifications are located in the [`/containers`](./containers) directory.
+* **Usage**: For instructions on building custom images or using existing ones from CVMFS, see the [Container Documentation](./containers/README.md).

checks/python-formatting.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+
+# Configuration
+APPLY_FIXES=false
+
+# Parse CLI arguments
+while [[ "$#" -gt 0 ]]; do
+    case $1 in
+        --apply) APPLY_FIXES=true ;;
+        *) echo "Unknown parameter: $1"; exit 1 ;;
+    esac
+    shift
+done
+
+echo "🔍 Finding Python files ..."
+
+# Find tracked python files
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+FILES=$(git ls-files | grep -E '\.py$' | grep -vEf "$SCRIPT_DIR/format_ignore.txt")
+
+if [[ -z "$FILES" ]]; then
+    echo "No Python files found."
+    exit 0
+fi
+
+if [ "$APPLY_FIXES" = true ]; then
+    echo "🛠  Running black to fix formatting..."
+    # Black formats in-place by default
+    echo "$FILES" | xargs black
+    echo "✅ Python formatting complete."
+else
+    echo "🧪 Checking Python formatting (Dry Run)..."
+
+    # --check: return exit code 1 if files need formatting
+    # --diff: show what would change
+    # --quiet: reduce noise, we only want the diffs/errors
+    if echo "$FILES" | xargs black --check --diff; then
+        echo "✨ Python code is looking good!"
+        exit 0
+    else
+        echo "------------------------------------------------------"
+        echo "❌ ERROR: Python formatting violations found."
+        echo "Run this script with --apply to fix them."
+        echo "------------------------------------------------------"
+        exit 1
+    fi
+fi