cleanliness

Author: ewdurbin

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 99

cla/comments.py

@@ -3,9 +3,7 @@
 from cla.constants import NOT_SIGNED_BADGE, SENTINEL_MARKER, SIGNED_BADGE
 
 
-async def post_or_update_comment(
-    gh, message, target_repository_full_name, pull_request_number
-):
+async def post_or_update_comment(gh, message, target_repository_full_name, pull_request_number):
     # Check for existing comment
     existing_comment = None
     async for comment in gh.getiter(
@@ -40,19 +38,13 @@ async def post_or_update_fail_comment(
         f"[![CLA signed]({NOT_SIGNED_BADGE})]({settings.SITE_URL})"
         f"{SENTINEL_MARKER}"
     )
-    await post_or_update_comment(
-        gh, message, target_repository_full_name, pull_request_number
-    )
+    await post_or_update_comment(gh, message, target_repository_full_name, pull_request_number)
 
 
-async def post_or_update_success_comment(
-    gh, target_repository_full_name, pull_request_number
-):
+async def post_or_update_success_comment(gh, target_repository_full_name, pull_request_number):
     message = (
         "All commit authors signed the Contributor License Agreement.\n\n"
         f"[![CLA signed]({SIGNED_BADGE})]({settings.SITE_URL})"
         f"{SENTINEL_MARKER}"
     )
-    await post_or_update_comment(
-        gh, message, target_repository_full_name, pull_request_number
-    )
+    await post_or_update_comment(gh, message, target_repository_full_name, pull_request_number)

cla/constants.py

@@ -1,14 +1,6 @@
-SIGNED_BADGE = (
-    "https://img.shields.io/badge/"
-    "CLA%20Signed-FAE085"
-    "?style=flat-square"
-    "&logo=Python"
-)
+SIGNED_BADGE = "https://img.shields.io/badge/CLA%20Signed-FAE085?style=flat-square&logo=Python"
 NOT_SIGNED_BADGE = (
     "https://img.shields.io/badge/"
-    "CLA%20Not%20Signed-fa858b"
-    "?style=flat-square"
-    "&logo=Python"
-    "&logoColor=ffffff"
+    "CLA%20Not%20Signed-fa858b?style=flat-square&logo=Python&logoColor=ffffff"
 )
 SENTINEL_MARKER = "<!-- CLA BOT SIGNING COMMENT DO NOT EDIT -->"

cla/events.py

@@ -27,9 +27,7 @@ async def handle_pull_request(event, gh, *args, **kwargs):
     github_user_id = event.data.get("pull_request").get("user", {}).get("id")
     pull_request_id = event.data.get("pull_request", {}).get("id")
     pull_request_number = event.data.get("pull_request", {}).get("number")
-    pull_request_head_sha = (
-        event.data.get("pull_request", {}).get("head", {}).get("sha")
-    )
+    pull_request_head_sha = event.data.get("pull_request", {}).get("head", {}).get("sha")
     pull_request_url = event.data.get("pull_request", {}).get("html_url")
     target_repository_id = event.data.get("repository", {}).get("id")
     target_repository_full_name = event.data.get("repository", {}).get("full_name")
@@ -99,8 +97,7 @@ async def handle_pull_request(event, gh, *args, **kwargs):
     for author in authors:
         normalized_email = re.sub(r"\+[^)]*@", "@", author.email)
         signature = await Signature.objects.filter(
-            Q(email_address__iexact=author.email)
-            | Q(normalized_email__iexact=normalized_email)
+            Q(email_address__iexact=author.email) | Q(normalized_email__iexact=normalized_email)
         ).afirst()
         if signature is None:
             await PendingSignature.objects.aupdate_or_create(
@@ -119,9 +116,7 @@ async def handle_pull_request(event, gh, *args, **kwargs):
     if needs_signing:
         await fail_status_check(gh, target_repository_full_name, pull_request_head_sha)
     else:
-        await succeed_status_check(
-            gh, target_repository_full_name, pull_request_head_sha
-        )
+        await succeed_status_check(gh, target_repository_full_name, pull_request_head_sha)
 
     # Send/Update comments
     if needs_signing:
@@ -130,6 +125,4 @@ async def handle_pull_request(event, gh, *args, **kwargs):
             gh, email_addresses, target_repository_full_name, pull_request_number
         )
     else:
-        await post_or_update_success_comment(
-            gh, target_repository_full_name, pull_request_number
-        )
+        await post_or_update_success_comment(gh, target_repository_full_name, pull_request_number)

cla/migrations/0001_initial.py

@@ -8,7 +8,6 @@
 
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = [
@@ -65,7 +64,11 @@ class Migration(migrations.Migration):
                 (
                     "document",
                     markdownx.models.MarkdownxField(
-                        help_text="The document that contributors will sign <b>cannot</b> be edited or deleted after it has been created. You will have to draft, save, and assign a new document"
+                        help_text=(
+                            "The document that contributors will sign "
+                            "<b>cannot</b> be edited or deleted after it has been created. "
+                            "You will have to draft, save, and assign a new document"
+                        )
                     ),
                 ),
                 ("default", models.BooleanField(default=False)),

cla/models.py

@@ -80,9 +80,7 @@ class RepositoryMapping(models.Model):
     created_at = models.DateTimeField(auto_now_add=True)
     updated_at = models.DateTimeField(auto_now=True)
 
-    github_repository = models.ForeignKey(
-        Repository, null=True, on_delete=models.SET_NULL
-    )
+    github_repository = models.ForeignKey(Repository, null=True, on_delete=models.SET_NULL)
     agreement = models.ForeignKey(Agreement, on_delete=models.PROTECT)
 
     def __str__(self):

clabot/views.py

@@ -20,9 +20,7 @@ def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
         default_agreement = Agreement.objects.filter(default=True).first()
         if default_agreement:
-            context["agreement"] = markdown.markdown(
-                default_agreement.document
-            )
+            context["agreement"] = markdown.markdown(default_agreement.document)
         else:
             context["agreement"] = None
         return context
@@ -59,12 +57,8 @@ async def sign(request):
         return HttpResponseRedirect("/")
 
     emails = await sync_to_async(request.session.get)("emails")
-    if email_address.lower() not in [
-        e["email"].lower() for e in emails if e["verified"]
-    ]:
-        messages.info(
-            request, "Cannot sign using an email that has not been verified on GitHub."
-        )
+    if email_address.lower() not in [e["email"].lower() for e in emails if e["verified"]]:
+        messages.info(request, "Cannot sign using an email that has not been verified on GitHub.")
         return HttpResponseRedirect("/")
 
     if request.method == "POST":
@@ -83,9 +77,7 @@ async def sign(request):
                 agreement_id=agreement_id, email_address__iexact=email_address
             ).all()
         ):
-            to_resolve[pending_signature.github_repository_id].add(
-                pending_signature.ref
-            )
+            to_resolve[pending_signature.github_repository_id].add(pending_signature.ref)
         for repository_id, refs in to_resolve.items():
             repository = await Repository.objects.select_related("installation").aget(
                 repository_id=repository_id

pyproject.toml

@@ -0,0 +1,6 @@
+[tool.black]
+exclude = "migrations"
+line-length = 99
+[tool.isort]
+profile = "black"
+skip_glob = ["*/migrations/*"]

requirements.in

@@ -1,5 +1,11 @@
+# Dev
 black
 daphne
+flake8
+isort
+pip-tools
+
+# Base
 dj-database-url
 django
 django-github-app

requirements.txt

@@ -20,6 +20,8 @@ automat==24.8.1
     # via twisted
 black==25.1.0
     # via -r requirements.in
+build==1.2.2.post1
+    # via pip-tools
 cachetools==5.5.2
     # via django-github-app
 certifi==2025.1.31
@@ -36,6 +38,7 @@ click==8.1.8
     # via
     #   black
     #   django-typer
+    #   pip-tools
     #   typer-slim
     #   uvicorn
 constantly==23.10.4
@@ -65,6 +68,8 @@ django-typer[rich]==3.1.0
     # via django-github-app
 environs==14.1.1
     # via -r requirements.in
+flake8==7.2.0
+    # via -r requirements.in
 gidgethub==5.3.0
     # via django-github-app
 gunicorn==23.0.0
@@ -90,12 +95,16 @@ idna==3.10
     #   twisted
 incremental==24.7.2
     # via twisted
+isort==6.0.1
+    # via -r requirements.in
 markdown==3.7
     # via django-markdownx
 markdown-it-py==3.0.0
     # via rich
 marshmallow==3.26.1
     # via environs
+mccabe==0.7.0
+    # via flake8
 mdurl==0.1.2
     # via markdown-it-py
 mypy-extensions==1.0.0
@@ -105,12 +114,15 @@ oauthlib==3.2.2
 packaging==24.2
     # via
     #   black
+    #   build
     #   gunicorn
     #   marshmallow
 pathspec==0.12.1
     # via black
 pillow==11.1.0
     # via django-markdownx
+pip-tools==7.4.1
+    # via -r requirements.in
 platformdirs==4.3.7
     # via black
 psycopg2-binary==2.9.10
@@ -121,8 +133,12 @@ pyasn1==0.6.1
     #   service-identity
 pyasn1-modules==0.4.2
     # via service-identity
+pycodestyle==2.13.0
+    # via flake8
 pycparser==2.22
     # via cffi
+pyflakes==3.3.2
+    # via flake8
 pygments==2.19.1
     # via rich
 pyjwt[crypto]==2.10.1
@@ -131,6 +147,10 @@ pyjwt[crypto]==2.10.1
     #   pyjwt
 pyopenssl==25.0.0
     # via twisted
+pyproject-hooks==1.2.0
+    # via
+    #   build
+    #   pip-tools
 python-dotenv==1.1.0
     # via environs
 requests==2.32.3
@@ -166,10 +186,13 @@ urllib3==2.3.0
     #   sentry-sdk
 uvicorn==0.34.0
     # via -r requirements.in
+wheel==0.45.1
+    # via pip-tools
 whitenoise==6.9.0
     # via -r requirements.in
 zope-interface==7.2
     # via twisted
 
 # The following packages are considered to be unsafe in a requirements file:
+# pip
 # setuptools