feat(72): Checking style in CI

Checking for style correctness in CI. This is done for every PR.
job `lint` has been added and is a required job for all build.

Author: js-dieu

.circleci/config.yml

@@ -45,10 +45,14 @@ commands:
         type: string
         default: "7"
         description: "Pytest version to use for testing"
+      add_specific_requirements:
+        type: string
+        default: ""
+        description: "Add specific requirements listed in a file to the environment. "
       extra_deps:
         type: string
         default: ""
-        description: "Extra dependencies to install"
+        description: "Extra dependencies to install (given as a space separated string)"
       channels:
         type: string
         default: "https://conda.anaconda.org/conda-forge"
@@ -75,6 +79,10 @@ commands:
                       echo $dep >> requirements.txt
                     done
                   fi
+                  cat "" >> requirements.txt
+                  if [ "<< parameters.add_specific_requirements >>" != "" ]; then
+                    cat "<< parameters.add_specific_requirements >>" >> requirements.txt
+                  fi
             - run:
                 name: "Create environment"
                 command: |
@@ -107,6 +115,27 @@ commands:
                   micromamba install -n project -y python=<< parameters.python >> $requirements -c $channels
                   micromamba install -n project -y << parameters.extra_deps >> -c $channels
 
+  lint-project:
+    description: "Check code style"
+    steps:
+      - run:
+          name: "Check formatting (black)"
+          command: |
+            eval "$(micromamba shell hook --shell=bash)"
+            micromamba activate project
+            black .
+      - run:
+          name: "Check code style (flake8)"
+          command: |
+            eval "$(micromamba shell hook --shell=bash)"
+            micromamba activate project
+            flake8 .
+      - run:
+          name: "Check import order (isort)"
+          command: |
+            eval "$(micromamba shell hook --shell=bash)"
+            micromamba activate project
+            isort .
   test-project:
     description: "Run all the test and store the results"
     parameters:
@@ -164,10 +193,13 @@ commands:
 workflows:
   PR:
     jobs:
+      - lint
       - build:
           matrix: *build-matrix
           name: "build-py<< matrix.python >>-pytest << matrix.pytest >>"
           filters: *PR-only
+          requires:
+            - lint
 
   deploy:
     jobs:
@@ -186,6 +218,12 @@ workflows:
 
 
 jobs:
+  lint:
+    docker: *image
+    steps:
+      - make-env:
+          add_specific_requirements: requirements.dev.txt
+      - lint-project
   build:
     docker: *image
     parameters:

requirements.dev.txt

@@ -1,12 +1,11 @@
 black
 isort
-flake8==6.0.0
-flake8-builtins==2.1.0
-flake8-simplify==0.19.3
-flake8-comprehensions==3.10.1
-flake8-pytest-style==1.6.0
-flake8-return==1.2.0
-flake8-no-pep-420==2.3.0
-flake8-pyprojecttoml==0.0.2
-flake8-debugger==4.1.2
-flake8-simplify==0.19.3
+flake8=6.0.0
+flake8-builtins=2.1.0
+flake8-simplify=0.19.3
+flake8-comprehensions=3.10.1
+flake8-pytest-style=1.6.0
+flake8-return=1.2.0
+flake8-no-pep420=2.7.0
+flake8-pyproject=1.2.3
+flake8-simplify=0.19.3

requirements.txt

@@ -2,3 +2,5 @@ psutil>=5.1.0
 memory_profiler>=0.58
 pytest
 requests
+black
+isort