Minor depend blocking

.github/workflows/ci.yml

@@ -0,0 +1,80 @@
+name: CI
+
+on: # Specifies when workflow is triggered
+  push:
+    branches: main
+  pull_request:
+    branches: [main, master]
+    types: [opened, reopened, synchronize]
+  workflow_dispatch: # Enables a button inside of the Actions tab to run workflow manually
+
+permissions: # Permissions of the workflow
+  pull-requests: write
+  contents: read
+  issues: read
+
+jobs: # Jobs the workflow runs
+  Sonar-Analysis: # Job for SonarCloud code scanning
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo Data
+        uses: actions/checkout@v3
+
+      - name: SonarCloud Analysis
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          SONAR_TOKEN: ${{secrets.SONAR_TOKEN}}
+        with:
+          args:
+
+            # Project and organization keys from SonarCloud
+            -Dsonar.projectKey=Majikjack620_requirements
+            -Dsonar.organization=majikjack620
+
+  Dependabot-PR-Assigner: # Job for auto assigning a Dependabot PR
+    runs-on: ubuntu-latest
+    if: ${{github.actor == 'dependabot[bot]' && github.event_name == 'pull_request'}}
+    steps:
+      - name: Assign PR to Reviewer
+        uses: pozil/auto-assign-issue@v1
+        with:
+          repo-token: ${{secrets.TOKENIZED}}
+          assignees: Majikjack620
+          numOfAssignee: 1
+          allowSelfAssign: true
+
+  Dependency-Validator: # Job for checking if dependencies are out of date
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo Data
+        uses: actions/checkout@v3
+
+      - name: Set up python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Upgrade pip and install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install pip-check
+          pip install -r requirements.txt
+
+      - name: Check for outdated dependencies
+        run: |
+          pip list --outdated
+          pip list --outdated >> dependent.txt
+          pip-check >> check_major_minor.txt
+          python scripts/read_file.py >> $GITHUB_STEP_SUMMARY
+
+      - if: ${{github.event_name == 'pull_request'}}
+        name: Summarizing outdated dependency list
+        run: |
+          gh pr comment "$PR_URL" --body-file $GITHUB_STEP_SUMMARY
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+      - name: Pass/Fail Check
+        run: python scripts/check_pass_fail.py

requirements.txt

@@ -8,22 +8,14 @@ contourpy==1.0.6
     # via matplotlib
 cycler==0.11.0
     # via matplotlib
-fonttools==4.38.0
+fonttools==4.34.0
     # via matplotlib
-kiwisolver==1.4.4
+kiwisolver==1.3.1
     # via matplotlib
-matplotlib==3.6.2
+matplotlib==3.4.2
     # via
     #   -r requirements.in
     #   seaborn
-numpy==1.23.5
-    # via
-    #   -r requirements.in
-    #   contourpy
-    #   matplotlib
-    #   pandas
-    #   scipy
-    #   seaborn
 packaging==21.3
     # via matplotlib
 pandas==1.5.1
@@ -40,9 +32,9 @@ python-dateutil==2.8.2
     # via
     #   matplotlib
     #   pandas
-pytz==2022.6
+pytz==2021.1
     # via pandas
-scipy==1.9.3
+scipy==1.9.1
     # via seaborn
 seaborn==0.10.1
     # via -r requirements.in

scripts/check_pass_fail.py

@@ -0,0 +1,5 @@
+with open('check_major_minor.txt', 'r') as checker:
+  content = checker.read()
+
+  if 'Minor' in content:
+    exit("Cannot merge: Minor dependency update(s) available")

scripts/read_file.py

@@ -0,0 +1,60 @@
+# Open file with outdated dependencies
+with open('dependent.txt', 'r') as depend:
+
+  # If the file is empty, this means all dependencies are up to date
+  if depend == '':
+    print("## :heavy_check_mark: All dependencies up to date :heavy_check_mark:")
+
+  # If the file is not empty, we make a table out of it's content
+  else:
+
+    # Header
+    print("## :small_red_triangle_down: Outdated Dependencies List :small_red_triangle_down:")
+
+    # Read file line-by-line
+    for line in depend:
+      listings = list(line.split())
+      length = len(listings)
+
+      # Read line word-by-word
+      for i in range(length):
+
+        # If it is the last word in the line, advance to next line after printing
+        if i == length-1:
+          print(listings[i], end=" | \n")
+
+        # All other words will be printed as is with a '|' to make a table
+        else:
+          print(listings[i], end=" | ")
+
+    # Instructions outlining how to update outdated dependencies
+    print("##")
+    print("### Updating **SPECIFIC** Dependencies:")
+    print("""- Ensure that, at least, the dependency that is being updated in the ***requirements.txt*** file is connected to it's version with 
+    '***>=***' and not '***==***' (i.e. ***pandas>=1.5.1***)""")
+    print("- Go inside the folder with the ***requirements.txt*** file from your CLI")
+    print("- Run the following command in your CLI to update the dependency:")
+    print("  - ***pip install {DEPENDENCY_NAME} -U --force-reinstall***")
+
+    print("### Updating **ALL** Dependencies **(not recommended, will update dependencies with major updates)**:")
+    print("""- Ensure that ALL dependencies in the ***requirements.txt*** file are connected to their version with 
+    '***>=***' and not '***==***' (i.e. ***pandas>=1.5.1***)""")
+    print("- Go inside the folder with the ***requirements.txt*** file from your CLI")
+    print("- Run the following command in your CLI to update all dependencies:")
+    print("  - ***pip install -r requirements.txt -U --force-reinstall***")
+depend.close()
+
+# Open file that indicates major/minor upates
+with open('check_major_minor.txt', 'r') as checker:
+  content = checker.read()
+
+  # Print a line
+  print("##")
+
+  # Check for major updates
+  if 'Major' in content:
+    print("#### :warning: MAJOR DEPENDENCY UPDATE(S): Make sure to check the dependency docs before updating :warning:")
+
+  # Check for minor updates
+  if 'Minor' in content:
+    print("#### :x: MINOR DEPENDENCY UPDATE(S): Update these dependencies, otherwise the check will keep failing :x:")