Merge pull request #4 from max-models/3-static-analysis-with-isort-and-black

Updated the CI pipeline, added static analysis (only black and isort has to pass).

Added some templates

Author: max-models

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+
+...
+
+**To Reproduce**
+
+...
+
+**Expected behavior**
+
+...
+
+**Proposed solution**
+
+...
+
+**Additional context**
+
+...

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the feature**
+
+...
+
+
+**Proposed implementation**
+
+...
+
+**Additional context**
+
+...

.github/workflows/ci_pipeline.yml

@@ -1,31 +1,39 @@
-name: Python CI
+name: Testing
 
 on:
   push:
     branches:
       - main
+      - devel
   pull_request:
     branches:
       - main
+      - devel
 
 jobs:
   test:
     runs-on: ubuntu-latest
-
+    # strategy:
+    #   matrix:
+    #     python-version: ['3.12']
     steps:
       - name: Check out the code
         uses: actions/checkout@v3
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.x'  # Specify the Python version, e.g., '3.8'
+      # - name: Set up Python
+      #   uses: actions/setup-python@v4
+      #   with:
+      #     python-version: ${{ matrix.python-version }}
 
-      - name: Install dependencies
+      - name: Install python dependencies
         run: |
           python -m pip install --upgrade pip
           pip install .
 
+      - name: Inspect maxplotlib arguments
+        run: |
+          maxplotlib -h
+
       - name: Run tests
         run: |
-          pytest  # or replace with your testing command
+          pytest .

.github/workflows/static_analysis.yml

@@ -0,0 +1,60 @@
+name: Static analysis
+
+on:
+  push:
+    branches:
+      - main
+      - devel
+  pull_request:
+    branches:
+      - main
+      - devel
+
+jobs:
+  static-analysis:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v4
+
+      - name: Download and run cloc
+        run: |
+          curl -s https://raw.githubusercontent.com/AlDanial/cloc/master/cloc > cloc
+          chmod +x cloc
+          ./cloc --version
+          ./cloc $(git ls-files)
+
+      - name: Code formatting with black
+        run: |
+          pip install black
+          pip install "black[jupyter]"
+          black --check src/
+
+      - name: Code formatting with isort
+        run: |
+          pip install isort
+          isort --check src/
+
+      - name: Code formatting with prospector
+        continue-on-error: true
+        run: |
+          pip install mypy
+          mypy src/
+
+      - name: Code formatting with prospector
+        continue-on-error: true
+        run: |
+          pip install prospector
+          prospector src/
+      
+      - name: Code formatting with ruff
+        continue-on-error: true
+        run: |
+          pip install ruff
+          ruff check src/
+
+      - name: Code formatting with pylint
+        continue-on-error: true
+        run: |
+          pip install pylint
+          pylint src/