Merge pull request #12 from larsks/feature/pre-commit

Add pre-commit configuration and github workflows

Author: memalhot

.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 pre-commit checks
+
+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.10"
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+      - name: Install dependencies
+        run: |
+          uv sync --all-groups
+      - uses: pre-commit/[email protected]

.gitignore

@@ -2,4 +2,4 @@ check
 __pycache__
 .pytest_cache
 .coverage
-htmlcov
+htmlcov

.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

.yamllint.yaml

@@ -0,0 +1,10 @@
+extends: default
+rules:
+  line-length: disable
+  document-start: disable
+  indentation:
+    indent-sequences: whatever
+  hyphens:
+    max-spaces-after: 4
+  truthy:
+    check-keys: false

README.md

@@ -1,16 +1,66 @@
 # python-batchtools
 
-## Setting up your development environment
+## Set up your development environment
 
-Install [uv](https://github.com/astral-sh/uv), then run:
+### Install tools
+
+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, you can install the command using `pipx`. First, install `pipx`:
+
+    ```
+    sudo dnf -y install pipx
+    ```
+
+    And then use `pipx` to install `uv`:
+
+    ```
+    pipx install uv
+    ```
+
+2. Next, install `pre-commit`. As with `uv`, you can install this using your system package manager:
+
+    ```
+    sudo dnf -y install pre-commit
+    ```
+
+    Or you can install a possibly more recent version 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. To manually run all the checks:
+
+```
+pre-commit run --all-files
+```
+
+
+### 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

bd.py

@@ -1,5 +1,4 @@
 from typing import cast
-import typing_extensions
 from typing_extensions import override
 
 import argparse

bj.py

@@ -1,4 +1,3 @@
-import typing_extensions
 from typing_extensions import override
 
 import argparse

bl.py

@@ -1,4 +1,3 @@
-import typing_extensions
 from typing_extensions import override
 from typing import cast
 

bp.py

@@ -1,5 +1,4 @@
 from typing import cast
-import typing_extensions
 from typing_extensions import override
 
 import argparse