Add pre-commit configuration and github workflows

This commit introduces two new features to the repository:

1. It adds a configuration for the pre-commit [1] tool that includes a
   selection of basic linters as well as a configuration to run the unit
   tests.

   You can activate these local checks by installing the pre-commit tool
   (using `pip` or `pipx`) and then running `pre-commit install`; this will
   update your `.git/hooks/pre-commit` file to run the checks automatically
   as part of each commit.

   See README.md for additional information.

2. It adds GitHub workflows that run these tests as part of each push and
   pull request.

   This is particularly useful when collaborating with other developers,
   since it helps catch minor errors and ensure consistent code formatting
   before changes are committed to the repository.

[1]: https://pre-commit.com/

Author: larsks

.github/dependabot.yaml

@@ -0,0 +1,10 @@
+# Set update schedule for GitHub Actions
+
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: "weekly"

.github/workflows/precommit.yaml

@@ -0,0 +1,20 @@
+name: Run linters
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+      - name: Install dependencies
+        run: |
+          uv sync --all-groups
+      - uses: pre-commit/[email protected]

.github/workflows/tests.yaml

@@ -0,0 +1,24 @@
+name: Run unit tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  unit-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Install dependencies
+        run: |
+          uv sync --all-groups
+
+      - name: Run tests
+        run: |
+          uv run pytest -v

.gitignore

@@ -1 +1 @@
-check
+check

.pre-commit-config.yaml

@@ -0,0 +1,38 @@
+repos:
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.5.5
+    hooks:
+      - id: remove-tabs
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-symlinks
+      - id: detect-private-key
+
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.37.1
+    hooks:
+      - id: yamllint
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.2
+    hooks:
+      - id: ruff-check
+      - id: ruff-format
+
+  - repo: local
+    hooks:
+      - id: unit-tests
+        name: Run unit tests
+        entry: uv run pytest
+        language: python
+        types:
+          - python
+        pass_filenames: false

README.md

@@ -1,16 +1,62 @@
 # python-batchtools
 
-## Setting up your development environment
+## Set up your development environment
 
-Install [uv](https://github.com/astral-sh/uv), then run:
+### Tooling
+
+1. Start by installing `uv`. Depending on your distribution, this may be as simple as:
+
+    ```sh
+    sudo dnf -y install uv
+    ```
+
+    If you would like to run the latest version, your best bet is probably to start by installing `pipx`:
+
+    ```
+    sudo dnf -y install pipx
+    ```
+
+    And then using `pipx` to install `uv`:
+
+    ```
+    pipx install uv
+    ```
+
+2. Next, install `pre-commit`. As with the `uv`, you can install this using your system package manager:
+
+    ```
+    sudo dnf -y install pre-commit
+    ```
+
+    Or you can install it just for your user using `pipx`:
+
+    ```
+    pipx install pre-commit
+    ```
+
+
+### Activate pre-commit
+
+Activate `pre-commit` for your working copy of this repository by running:
+
+```
+pre-commit install
+```
+
+This will configure `.git/hooks/pre-commit` to run the `pre-commit` tool every time you make a commit. Running these tests locally ensures that your code is clean and that tests are passing before you share your code with others.
+
+
+### Install dependencies
+
+To install the project dependencies, run:
 
 ```
 uv sync --all-extras
 ```
 
-## Running tests
+### Run tests
 
-To run the unit tests:
+To run just the unit tests:
 
 ```
 uv run pytest

batchtools.py

@@ -59,7 +59,9 @@ def run(self, args: list[str] | None = None):
 
 def main() -> None:
     if not is_logged_in():
-        sys.exit("You are not logged in to the oc cli. Retrieve the token using 'oc login --web' or retrieving the login token from the openshift UI.")
+        sys.exit(
+            "You are not logged in to the oc cli. Retrieve the token using 'oc login --web' or retrieving the login token from the openshift UI."
+        )
 
     app = BatchTools()
     app.run()

bt-test.sh

@@ -39,7 +39,7 @@ python3 batchtools.py bl
 python3 batchtools.py bl csw-dev-0
 br nvidia-smi
 
-# ADD CASES HERE FOR 
+# ADD CASES HERE FOR
 br sleep 20 &
 # Needs bash to get jobs
 # python3 batchtools.py bl csw-dev-0 csw-dev-1
@@ -73,4 +73,4 @@ python3 batchtools.py bp
 # BR
 # ----------------------------------------------------------------------------------------
 python3 batchtools.py br nvidia-smi
-python3 batchtools.py br --wait 0 nvidia-smi
+python3 batchtools.py br --wait 0 nvidia-smi

helpers.py

@@ -8,6 +8,7 @@ def is_logged_in() -> bool:
     except oc.OpenShiftPythonException:
         return False
 
+
 def pretty_print(pod: oc.APIObject) -> str:
     formatted_logs: str = ""
     try:

pyproject.toml

@@ -24,7 +24,7 @@ analyzeUnannotatedFunctions = false
 
 
 [tool.pytest.ini_options]
-addopts = "--cov=. --cov-report=html -v"
+addopts = "--cov=. --cov-report=html"
 
 [tool.coverage.report]
 omit = ["tests/*"]