Format source code to PEP8 using Ruff (#36)

* added ruff docs

* style: Run ruff and black before yapf pass

* yapf -r -i (23 fixes)

* fixed conf.py and ran ruff format .

* fixed conf.py 2

* formatted argparser.py

* formatted src/rocprof_compute_analyze

* formatted src/rocprof_compute_profile

* formatted soc_base.py

* formatted rocprof_compute_tui

* formatted gui_components

* formatted src/utils

* formatted tests/

* format extra files

* cleanup

* fix test_utils.py

* fixed typos

* Update pyproject.toml

* Update README.md

* Update test_utils.py

---------

Signed-off-by: jamessiddeley-amd <James.Siddeley@amd.com>
Co-authored-by: James Siddeley <James.Siddeley@amd.com>
Co-authored-by: systems-assistant[bot] <systems-assistant[bot]@users.noreply.github.com>

projects/rocprofiler-compute/.github/workflows/formatting.yml

@@ -25,14 +25,26 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install black isort
+        python -m pip install ruff
         if [ -f requirements.txt ]; then python -m pip install -r requirements.txt; fi
-    - name: Run black formatter
-      uses: psf/black@stable
-      with:
-        use_pyproject: true
-    - name: Run isort formatter
-      uses: isort/isort-action@master
+    - name: Run Ruff Linter and Import Sorter
+      run: |
+        ruff check . --fix --exit-zero
+    - name: Run Ruff Formatter
+      run: |
+        ruff format .
+    - name: Check for formatting/linting changes
+      run: |
+        git config --global user.name 'github-actions'
+        git config --global user.email 'github-actions@github.com'
+        git add -A .
+        if ! git diff --cached --quiet; then
+          echo "::error::Files were modified by ruff. Please run 'ruff check . --fix && ruff format .' locally and commit the changes."
+          git diff --cached --patch # Show the diff in the logs
+          exit 1
+        else
+          echo "Ruff found no issues or all issues were fixed and files are clean."
+        fi
 
   cmake:
     runs-on: ubuntu-22.04