Merge pull request #28 from EventAccess/sergeihychko-dev

Add Python linting

Author: oddstr13

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Autoformat: black
+2ee4a7853e7eb55e47653d5f69f271f858a6d3a8

.github/workflows/python-linting.yaml

@@ -0,0 +1,88 @@
+name: Python
+on:
+  pull_request:
+  push:
+    branches:
+      - dev
+jobs:
+  python-mypy:
+    name: Mypy
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v4.2.2
+
+      - name: Set up Python
+        uses: actions/setup-python@v5.3.0
+        with:
+          python-version: 3.12
+          cache: 'pip'
+          cache-dependency-path: |
+            **/requirements.txt
+            **/requirements-*.txt
+
+      - name: Install reviewdog
+        uses: reviewdog/action-setup@v1.3.0
+        with:
+          reviewdog_version: latest
+
+      - name: Install dependencies
+        run: pip install -r requirements-dev.txt
+
+      - name: Run MyPy
+        run: |
+          mypy --output=json \
+          | jq -Mac '{"message":(.message+"\n"+.hint),"location":{"path":.file,"range":{"start":{"line":.line,"column":.column}}},"severity":.severity|ascii_upcase,"code":{"url":"https://mypy.readthedocs.io/en/stable/error_code_list.html","value":.code}}' \
+          | reviewdog -f=rdjsonl -reporter=github-check -name mypy -fail-level warning -filter-mode nofilter
+        env:
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  python-black:
+    name: Black
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v4.2.2
+
+      - name: Set up Python
+        uses: actions/setup-python@v5.3.0
+        with:
+          python-version: 3.12
+          cache: 'pip'
+          cache-dependency-path: |
+            **/requirements.txt
+            **/requirements-*.txt
+
+      - name: Install reviewdog
+        uses: reviewdog/action-setup@v1.3.0
+        with:
+          reviewdog_version: v0.20.1
+
+      - name: Install dependencies
+        run: pip install -r requirements-dev.txt
+
+      - name: Run Black
+        if: github.event_name == 'pull_request'
+        uses: reviewdog/action-black@v3.22.2
+        with:
+          reporter: github-pr-review
+          tool_name: black
+          level: warning
+          fail_on_error: true
+          filter_mode: nofilter
+
+      - name: Run Black
+        if: github.event_name == 'push'
+        uses: reviewdog/action-black@v3.22.2
+        with:
+          reporter: github-check
+          tool_name: black
+          level: warning
+          fail_on_error: true
+          filter_mode: nofilter

backendapi/admin.py

@@ -5,7 +5,7 @@
 
 @admin.register(Attendant)
 class AttendantAdmin(admin.ModelAdmin):
-    list_display = ('ticket_id', 'nfc_id_decoded', 'discord', 'is_crew', 'is_valid')
+    list_display = ("ticket_id", "nfc_id_decoded", "discord", "is_crew", "is_valid")
 
     def nfc_id_decoded(self, obj):
         return b16encode(obj.nfc_id).decode()

backendapi/urls.py

@@ -7,8 +7,6 @@
 urlpatterns = [
     path("nfctag/<hex:tag>", views.scanned),
     path("test", views.api_get, name="api_get"),
-    path("tickets/verify/<slug:ticket>",
-         views.verify_ticket,
-         name="verify_ticket"),
-    path("attendants", views.create_attendant, name="create_attendant")
+    path("tickets/verify/<slug:ticket>", views.verify_ticket, name="verify_ticket"),
+    path("attendants", views.create_attendant, name="create_attendant"),
 ]

backendapi/views.py

@@ -34,12 +34,14 @@ def api_get(request):
 @api_view(["GET"])
 def verify_ticket(request, ticket):
     # TODO: Implement ticket check
-    if ticket == 'test123':
+    if ticket == "test123":
         return Response(
-            {"is_valid": True}, status=status.HTTP_200_OK,
+            {"is_valid": True},
+            status=status.HTTP_200_OK,
         )
     return Response(
-        {"is_valid": False}, status=status.HTTP_400_BAD_REQUEST,
+        {"is_valid": False},
+        status=status.HTTP_400_BAD_REQUEST,
     )