add pre-commit for easy linting/formatting! (#606)

* add pre-commit for easy linting/formatting!
Signed-off-by: vsoch <[email protected]>

Author: vsoch

.all-contributorsrc

@@ -133,4 +133,4 @@
         }
     ],
     "contributorsPerLine": 7
-}
+}

.circleci/config.yml

@@ -65,7 +65,7 @@ install_podman: &install_podman
     wget -nv https://download.opensuse.org/repositories/devel:kubic:libcontainers:stable/xUbuntu_${VERSION_ID}/Release.key -O- | sudo apt-key add -
     sudo apt-get update -qq
     sudo apt-get -qq -y install podman
- 
+
 install_dependencies: &install_dependencies
   name: install dependencies
   command: |-
@@ -87,7 +87,7 @@ install_dependencies: &install_dependencies
 
 test_shpc: &test_shpc
   name: Test Singularity Registry HPC
-  command: |- 
+  command: |-
       export PATH=~/conda/Python3/bin:$PATH
       python --version
       cd ~/repo

.github/CONTRIBUTING.md

@@ -4,10 +4,10 @@ This code is licensed under the MPL 2.0 [LICENSE](LICENSE).
 
 # Contributing
 
-When contributing to Singularity Registry Global Client, it is 
-important to properly communicate the gist of the contribution. 
-If it is a simple code or editorial fix, simply explaining this 
-within the GitHub Pull Request (PR) will suffice. But if this is a larger 
+When contributing to Singularity Registry Global Client, it is
+important to properly communicate the gist of the contribution.
+If it is a simple code or editorial fix, simply explaining this
+within the GitHub Pull Request (PR) will suffice. But if this is a larger
 fix or Enhancement, it should be first discussed with the project
 leader or developers.
 
@@ -29,8 +29,8 @@ all your interactions with the project members and users.
 4. The project's default copyright and header have been included in any new
    source files.
 5. All (major) changes to Singularity Registry must be documented in
-   [docs](docs). If your PR changes a core functionality, please 
-   include clear description of the changes in your PR so that the docs 
+   [docs](docs). If your PR changes a core functionality, please
+   include clear description of the changes in your PR so that the docs
    can be updated, or better, submit another PR to update the docs directly.
 6. If necessary, update the README.md.
 7. The pull request will be reviewed by others, and the final merge must be
@@ -102,7 +102,7 @@ an incident. Further details of specific enforcement policies may be posted
 separately.
 
 Project maintainers, contributors and users who do not follow or enforce the
-Code of Conduct in good faith may face temporary or permanent repercussions 
+Code of Conduct in good faith may face temporary or permanent repercussions
 with their involvement in the project as determined by the project's leader(s).
 
 ## Attribution

.github/ISSUE_TEMPLATE/documentation-or-tutorial-request.md

@@ -3,5 +3,3 @@ name: Documentation or Tutorial Request
 about: What can we explain better, or what issue did you find?
 
 ---
-
-

.github/ISSUE_TEMPLATE/question.md

@@ -3,5 +3,3 @@ name: Question
 about: What's on your mind?
 
 ---
-
-

.github/dev-requirements.txt

@@ -0,0 +1,4 @@
+pre-commit
+black
+isort
+flake8

.github/test-centos.yml

@@ -34,7 +34,7 @@ jobs:
             touch changes.txt
             for container_yaml in $(git diff --name-only HEAD~$commits..HEAD .); do
                 echo $container_yaml >> changes.txt
-            done            
+            done
             cat changes.txt
 
       - name: Update .bashrc

.github/workflows/main.yml

@@ -6,14 +6,12 @@ on:
     branches-ignore:
       - main
       - gh-pages
-      - binoc/*
-      - binoc/**
 
 jobs:
   formatting:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
 
       - name: Setup black linter
         run: conda create --quiet --name black pyflakes
@@ -23,15 +21,9 @@ jobs:
         with:
           files: ./docs/getting_started/ ./docs/index.rst
 
-      - name: Lint python code
+      - name: Lint and format Python code
         run: |
           export PATH="/usr/share/miniconda/bin:$PATH"
           source activate black
-          pip install black
-          black --check shpc
-          
-      - name: Check imports with pyflakes
-        run: |
-          export PATH="/usr/share/miniconda/bin:$PATH"
-          source activate black
-          find shpc/ -name '*.py' \! -name __init__.py \! -name shell.py -exec pyflakes \{\} \+
+          pip install -r .github/dev-requirements.txt
+          pre-commit run --all-files

.github/workflows/release.yaml

@@ -22,7 +22,7 @@ jobs:
         pip install setuptools wheel twine
     - name: Build and publish
       env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USER }} 
+        TWINE_USERNAME: ${{ secrets.PYPI_USER }}
         TWINE_PASSWORD: ${{ secrets.PYPI_PASS }}
       run: |
         export PATH="/usr/share/miniconda/bin:$PATH"

.github/workflows/test-container.yml

@@ -16,7 +16,7 @@ jobs:
         uses: jitterbit/get-changed-files@b17fbb00bdc0c0f63fcf166580804b4d2cdc2a42
         with:
           format: 'json'
-  
+
   test-recipes:
     needs:
       - changes
@@ -34,10 +34,10 @@ jobs:
           # Continue if we have a changed recipe file
           if [[ "${{ matrix.changed_recipe }}" = registry* ]]; then
             recipe_basename=$(basename "${{ matrix.changed_recipe }}")
-            if [[ "${recipe_basename}" == "container.yaml" ]]; then  
+            if [[ "${recipe_basename}" == "container.yaml" ]]; then
               echo "keepgoing=true" >> $GITHUB_ENV
             fi
-          fi          
+          fi
 
       - name: Checkout
         if: ${{ env.keepgoing == 'true' }}