Merge branch 'main' into pylint

Author: MattyTheHacker

.github/workflows/auto-label.yaml

@@ -0,0 +1,28 @@
+name: "Automatically mark PRs to sync"
+
+on:
+  pull_request:
+    types:
+      - opened
+
+jobs:
+  labeler:
+    if: github.event.pull_request.user.type != 'Bot'
+    permissions:
+      pull-requests: write
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Add "sync" label to PR
+        run: gh pr edit "$PR_URL" --add-label sync --repo "$PR_REPO"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          PR_REPO: ${{ github.repository }}
+
+      - name: Comment on PR to explain sync label
+        run: gh pr comment "$PR_URL" --body "This pull request has been marked to **automatically sync** to its base branch. You can **disable** this behavior by removing the `sync` label." --repo "$PR_REPO"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          PR_REPO: ${{ github.repository }}

.github/workflows/autoupdate.yaml

@@ -0,0 +1,19 @@
+name: pr-auto-update
+on:
+  push: {}
+
+jobs:
+  pr-auto-update:
+    name: Automatic PR Updater
+    runs-on: ubuntu-latest
+    permissions: 
+      pull-requests: write
+      contents: write
+    steps:
+      - uses: CSSUoB/pr-auto-updater@v2.2.2
+        env:
+          GITHUB_TOKEN: '${{ secrets.PR_AUTO_UPDATE_TOKEN }}'
+          PR_FILTER: 'labelled'
+          PR_LABELS: 'sync'
+          MERGE_CONFLICT_ACTION: 'label'
+          MERGE_CONFLICT_LABEL: 'conflict'

.github/workflows/pr-auto-merge.yaml

@@ -0,0 +1,23 @@
+name: "Automatically enable auto-merge on PRs"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - ready_for_review
+    branches:
+      - main
+
+jobs:
+  enable-automerge:
+    if: github.event.pull_request.draft == false
+    permissions:
+      pull-requests: write
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Enable auto-merge for the PR
+        run: gh pr merge "$PR_URL" --auto --squash
+        env:
+          GH_TOKEN: ${{ secrets.PR_AUTO_UPDATE_TOKEN }}
+          PR_URL: ${{ github.event.pull_request.html_url }}

css-reports/app.py

@@ -1,25 +1,32 @@
-from flask import Flask, request, send_file, jsonify, redirect
-from report import get_product_customisations
+"""Module to handle the incoming http requests and generate reports."""
+
 from datetime import datetime
 import os
 import re
 
+from flask import Flask, request, send_file, jsonify, redirect
+from report import get_product_customisations
+
+
 app = Flask("css-reports")
 
 
 @app.route("/")
 def hello():
+    """Redirect to the main website if no specific route is requested."""
     return redirect("https://cssbham.com", code=302)
 
 
 @app.errorhandler(404)
 def page_not_found(e: Exception | int):
+    """Handle 404 errors by redirecting to the main website."""
     print(e)
     return redirect("https://cssbham.com", code=302)
 
 
 @app.route("/customisation_report", methods=["GET"])
 async def fetch_customisation_report():
+    """Fetch the report based on query parameters."""
     # Retrieve query parameters
     auth_cookie: str | None = request.args.get("auth_cookie")
     organisation_id: str | None = request.args.get("organisation_id")

css-reports/report.py

@@ -1,11 +1,13 @@
 """Python script to fetch a customisation report from the Guild website."""
 
+import re
+from datetime import datetime
+
 from typing import Final, Mapping, TYPE_CHECKING
 import aiohttp
 import bs4
 from bs4 import BeautifulSoup
-import re
-from datetime import datetime
+
 
 if TYPE_CHECKING:
     from http.cookies import Morsel
@@ -83,9 +85,8 @@ async def fetch_report_url_and_cookies(
     SALES_REPORTS_URL: Final[str] = (
         f"https://www.guildofstudents.com/organisation/salesreports/{org_id}/"
     )
-    data_fields, cookies = await get_msl_context(
-        url=SALES_REPORTS_URL, auth_cookie=auth_cookie
-    )
+
+    data_fields, cookies = await get_msl_context(url=SALES_REPORTS_URL, auth_cookie=auth_cookie)
 
     form_data: dict[str, str] = {
         SALES_FROM_DATE_KEY: from_date.strftime("%d/%m/%Y"),
@@ -105,9 +106,10 @@ async def fetch_report_url_and_cookies(
         headers=BASE_HEADERS,
         cookies=cookies,
     )
-
-    async with (session_v2, session_v2.post(url=SALES_REPORTS_URL, data=data_fields) as http_response):  # noqa: E501
-
+    async with (
+        session_v2,
+        session_v2.post(url=SALES_REPORTS_URL, data=data_fields) as http_response
+    ):
         if http_response.status != 200:
             print("Returned a non 200 status code!!")
             print(http_response)