Merge pull request #27 from blowekamp/add_precommit_black

Add pre-commit configuration with black and run in GHA as listing

Author: blowekamp

.github/workflows/python-app.yml

@@ -10,7 +10,31 @@ on:
     branches: [ main ]
 
 jobs:
-  build:
+
+  linting_test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.11
+    - name: set PY
+      run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV
+    - uses: actions/cache@v3
+      with:
+        path: ~/.cache/pre-commit
+        key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
+    - name: Linting
+      run: |
+        pip install pre-commit
+        pre-commit run --all-files
+
+
+  test_package:
+    needs: linting_test
 
     runs-on: ubuntu-latest
 
@@ -20,18 +44,11 @@ jobs:
       uses: actions/setup-python@v4
       with:
         python-version: 3.9
+        cache: 'pip'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
         pip install -e .
-    - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings.
-        flake8 . --count --exit-zero --max-complexity=10 --statistics
     - name: Run tests
       run: |
         python -m unittest discover -s tests

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+# .pre-commit-config.yaml
+# for details see https://pre-commit.com
+# for list of available hooks see https://pre-commit.com/hooks.html
+
+fail_fast: true
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+   -   id: check-added-large-files
+       args: ['--maxkb=200']
+- repo: https://github.com/psf/black
+  rev: 23.3.0
+  hooks:
+   - id: black
+     args: ['--check', '--diff']
+- repo: https://github.com/pycqa/flake8
+  rev: 6.0.0
+  hooks:
+   - id: flake8
+     entry: pflake8
+     additional_dependencies: [pyproject-flake8]