Use pre-commit to check styles

.github/ISSUE_TEMPLATE/0_new_bigfunction.yaml

@@ -6,14 +6,14 @@ body:
   - type: markdown
     attributes:
       value: |
-         ## 🙏 Thanks for taking the time to suggest a new BigFunction! 
-         
+         ## 🙏 Thanks for taking the time to suggest a new BigFunction!
+
          Please fill the below fields to submit your idea.
   - type: checkboxes
     id: idea_does_not_exist
     attributes:
       label: Check the idea has not already been suggested
-      description: Check in [existing issues](https://github.com/unytics/bigfunctions/issues?q=is%3Aissue+is%3Aopen+label%3Anew-bigfunction) if your idea has not already been suggested. If it has, please don't create a new issue but add a comment on the existing one such as `+1` to upvote it. 
+      description: Check in [existing issues](https://github.com/unytics/bigfunctions/issues?q=is%3Aissue+is%3Aopen+label%3Anew-bigfunction) if your idea has not already been suggested. If it has, please don't create a new issue but add a comment on the existing one such as `+1` to upvote it.
       options:
         - label: I could not find my idea in [existing issues](https://github.com/unytics/bigfunctions/issues?q=is%3Aissue+is%3Aopen+label%3Anew-bigfunction)
           required: true

.github/ISSUE_TEMPLATE/1_bug_bigfunction.yaml

@@ -6,22 +6,22 @@ body:
   - type: markdown
     attributes:
       value: |
-         ## 🙏 Thanks for taking the time to report a bug in a BigFunction! 
-         
+         ## 🙏 Thanks for taking the time to report a bug in a BigFunction!
+
          Please fill the below fields to submit it.
   - type: checkboxes
     id: idea_does_not_exist
     attributes:
       label: Check the bug has not already been reported
-      description: Check in [existing issues](https://github.com/unytics/bigfunctions/issues?q=is%3Aissue+is%3Aopen+label%3Abug-bigfunction) if your idea has not already been suggested. If it has, please don't create a new issue but add a comment on the existing one such as `+1` to upvote it. 
+      description: Check in [existing issues](https://github.com/unytics/bigfunctions/issues?q=is%3Aissue+is%3Aopen+label%3Abug-bigfunction) if your idea has not already been suggested. If it has, please don't create a new issue but add a comment on the existing one such as `+1` to upvote it.
       options:
         - label: I could not find the bug in [existing issues](https://github.com/unytics/bigfunctions/issues?q=is%3Aissue+is%3Aopen+label%3Abug-bigfunction)
           required: true
   - type: checkboxes
     id: title_is_ok
     attributes:
       label: Edit `function_name` and the short error description in title above
-      description: Edit the `function_name` and the short error description in the issue title above. 
+      description: Edit the `function_name` and the short error description in the issue title above.
       options:
         - label: I wrote the correct function name and a short error description in the title above
           required: true

.github/ISSUE_TEMPLATE/2_improve_bigfunction.yaml

@@ -6,22 +6,22 @@ body:
   - type: markdown
     attributes:
       value: |
-         ## 🙏 Thanks for taking the time to help us improve! 
-         
+         ## 🙏 Thanks for taking the time to help us improve!
+
          Please fill the below fields to submit it.
   - type: checkboxes
     id: idea_does_not_exist
     attributes:
       label: Check your idea has not already been reported
-      description: Check in [existing issues](https://github.com/unytics/bigfunctions/issues?q=is%3Aissue+is%3Aopen+label%3Abug-bigfunction) if your idea has not already been suggested. If it has, please don't create a new issue but add a comment on the existing one such as `+1` to upvote it. 
+      description: Check in [existing issues](https://github.com/unytics/bigfunctions/issues?q=is%3Aissue+is%3Aopen+label%3Abug-bigfunction) if your idea has not already been suggested. If it has, please don't create a new issue but add a comment on the existing one such as `+1` to upvote it.
       options:
         - label: I could not find the idea in [existing issues](https://github.com/unytics/bigfunctions/issues?q=is%3Aissue+is%3Aopen+label%3Abug-bigfunction)
           required: true
   - type: checkboxes
     id: title_is_ok
     attributes:
       label: Edit `function_name` and the short idea description in title above
-      description: Edit the `function_name` and the short idea description in the issue title above. 
+      description: Edit the `function_name` and the short idea description in the issue title above.
       options:
         - label: I wrote the correct function name and a short idea description in the title above
           required: true

.github/ISSUE_TEMPLATE/3_bug_bigfun_cli.yaml

@@ -6,14 +6,14 @@ body:
   - type: markdown
     attributes:
       value: |
-         ## 🙏 Thanks for taking the time to report a bug of `bigfun` Command-Line-Interface! 
-         
+         ## 🙏 Thanks for taking the time to report a bug of `bigfun` Command-Line-Interface!
+
          Please fill the below fields to submit it.
   - type: checkboxes
     id: idea_does_not_exist
     attributes:
       label: Check the bug has not already been reported
-      description: Check in [existing issues](https://github.com/unytics/bigfunctions/issues?q=is%3Aissue+is%3Aopen+label%3Abug-bigfun-CLI) if your idea has not already been suggested. If it has, please don't create a new issue but add a comment on the existing one such as `+1` to upvote it. 
+      description: Check in [existing issues](https://github.com/unytics/bigfunctions/issues?q=is%3Aissue+is%3Aopen+label%3Abug-bigfun-CLI) if your idea has not already been suggested. If it has, please don't create a new issue but add a comment on the existing one such as `+1` to upvote it.
       options:
         - label: I could not find the bug in [existing issues](https://github.com/unytics/bigfunctions/issues?q=is%3Aissue+is%3Aopen+label%3Abug-bigfun-CLI)
           required: true

.github/ISSUE_TEMPLATE/4_improve_bigfun_cli.yaml

@@ -7,13 +7,13 @@ body:
     attributes:
       value: |
          ## 🙏 Thanks for taking the time to help us improve!
-         
+
          Please fill the below fields to submit your idea.
   - type: checkboxes
     id: idea_does_not_exist
     attributes:
       label: Check your idea has not already been reported
-      description: Check in [existing issues](https://github.com/unytics/bigfunctions/issues?q=is%3Aissue+is%3Aopen+label%3Aimprove-bigfun-CLI) if your idea has not already been suggested. If it has, please don't create a new issue but add a comment on the existing one such as `+1` to upvote it. 
+      description: Check in [existing issues](https://github.com/unytics/bigfunctions/issues?q=is%3Aissue+is%3Aopen+label%3Aimprove-bigfun-CLI) if your idea has not already been suggested. If it has, please don't create a new issue but add a comment on the existing one such as `+1` to upvote it.
       options:
         - label: I could not find the idea in [existing issues](https://github.com/unytics/bigfunctions/issues?q=is%3Aissue+is%3Aopen+label%3Aimprove-bigfun-CLI)
           required: true

.github/workflows/deploy_pages.yml

@@ -8,8 +8,8 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.x
       - run: pip install -e .

.github/workflows/lint.yml

@@ -0,0 +1,24 @@
+name: lint
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          pip install -e .[dev]
+      - name: Run pre-commit
+        run: |
+          pre-commit run --all-files

.gitignore

@@ -143,4 +143,4 @@ tests/
 site/
 
 TEST
-venv
+venv

.pre-commit-config.yaml

@@ -0,0 +1,57 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-json
+      - id: check-toml
+      - id: check-yaml
+      - id: detect-private-key
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.10.0
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - types-PyYAML
+        files: "^logingress/.*"
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.1
+    hooks:
+      - id: actionlint-docker
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+      - id: shellcheck
+  # TODO enable the hook
+  # - repo: https://github.com/PyCQA/bandit
+  #   rev: 1.7.9
+  #   hooks:
+  #     - id: bandit
+  #       name: bandit (python)
+  #       args: [--configfile, bandit.yaml, --severity-level, all]
+  #       additional_dependencies: [bandit]
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        name: isort (python)
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.35.1
+    hooks:
+      - id: yamllint
+        args: [--strict, -c=.yamllint]
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+      - id: shellcheck
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        name: isort (python)
+  # TODO enable the hook
+  # - repo: https://github.com/hadolint/hadolint
+  #   rev: v2.13.0-beta
+  #   hooks:
+  #     - id: hadolint-docker

.yamllint

@@ -0,0 +1,10 @@
+---
+rules:
+  trailing-spaces: disable
+  key-duplicates: {}
+  colons:
+    max-spaces-before: 0
+    max-spaces-after: 1
+  indentation:
+    spaces: 2
+    check-multi-line-strings: false

README.md

@@ -121,7 +121,7 @@ Commands:
 
 ### 5.3 Create you first function 👷
 
-Functions are defined as yaml files under `bigfunctions` folder. To create your first function locally, the easiest is to download an existing yaml file of unytics/bigfunctions Github repo. 
+Functions are defined as yaml files under `bigfunctions` folder. To create your first function locally, the easiest is to download an existing yaml file of unytics/bigfunctions Github repo.
 
 For instance to download `is_email_valid.yaml` into bigfunctions folder, do:
 
@@ -229,4 +229,3 @@ BigFunctions is fully open-source. Any contribution is more than welcome 🤗!
 <a href="https://github.com/unytics/bigfunctions/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=unytics/bigfunctions" />
 </a>
-

bandit.yaml

@@ -0,0 +1,6 @@
+# SEE https://bandit.readthedocs.io/en/latest/config.html
+exclude_dirs:
+  - "tests"
+skips:
+  # hardcoded_sql_expressions
+  - "B608"

bigfun/bigfunctions.py

@@ -1,14 +1,16 @@
-import tempfile
-import re
+import functools
+import json
 import os
+import re
 import shutil
-import json
-import functools
+import tempfile
 
-import yaml
 import jinja2
+import yaml
 
-from .utils import BigQuery, CloudRun, handle_error, print_success, print_info, print_command, build_and_upload_npm_package, merge_dict
+from .utils import (BigQuery, CloudRun, build_and_upload_npm_package,
+                    handle_error, merge_dict, print_command, print_info,
+                    print_success)
 
 BIGFUNCTIONS_FOLDER = 'bigfunctions'
 DEFAULT_CONFIG_FILENAME = './config.yaml'