Add Ruff formatting and linting (#313)

* Ruff linter and formatter

* Add pre-commit as dependency

* Use Penn Clubs ruff settings

* Add to CICD

* Add linting to new changes

Author: julianweng

.github/workflows/build-and-deploy.yaml

@@ -15,6 +15,14 @@ jobs:
         run: |-
           cd .
           uv sync --frozen
+      - name: Lint
+        run: |-
+          cd .
+          uv run ruff check .
+      - name: Format
+        run: |-
+          cd .
+          uv run ruff format .
       - name: Test (run in parallel)
         run: |-
           cd .

.pre-commit-config.yaml

@@ -1,7 +1,18 @@
 repos:
-  - repo: https://github.com/pennlabs/pre-commit-hooks
-    rev: stable
+  - repo: local
     hooks:
-        - id: black
-        - id: isort
-        - id: flake8
+      - id: ruff-format
+        name: Ruff Formatter
+        entry: uv run ruff format .
+        language: python
+        types: [python]
+        require_serial: true
+        files: /
+        pass_filenames: false
+      - id: ruff-lint-fix
+        name: Ruff Lint (Apply Fixes)
+        entry: uv run ruff check . --fix
+        language: python
+        types: [python]
+        require_serial: true
+        files: /

README.md

@@ -1,42 +1,33 @@
 Common Funding Application
-=============================
+==========================
 
 [![CircleCI](https://circleci.com/gh/pennlabs/common-funding-application.svg?style=shield)](https://circleci.com/gh/pennlabs/common-funding-application)
 [![Coverage Status](https://codecov.io/gh/pennlabs/common-funding-application/branch/master/graph/badge.svg)](https://codecov.io/gh/pennlabs/common-funding-application)
 
 The [Common Funding Application](https://penncfa.com) is an online application that allows student groups and organizations to request funding from various funding sources at the [University of Pennsylvania](http://www.upenn.edu).
 
 ## Local Backend Setup
-* Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
 
+* Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
 * Install `mysql_config` (Ubuntu: `apt install libmysqlclient-dev` / MacOS: `brew install mysql-connector-c`)
-
 * Install python dependencies (`uv sync`)
-
+* Install pre-commit (`uv run pre-commit install`)
 * Migrate database (`uv run manage.py migrate`)
-
 * Import dummy data (`uv run import_demo.py`)
-
 * Run the server (`uv run manage.py runserver`)
-
 * Navigate to the [app](http://localhost:8000/)
-
 * Example login credntials: `philo / philo` for requester, `spectrum / spectrum` for funder
 
 ## Front-End Setup
 
 * Install [Bun](https://bun.sh/docs/installation)
-
 * Install [Mocha](https://mochajs.org/#installation) (`bun install -g mocha`)
-
 * Run tests (`mocha app/static/test/`)
 
 ## DB migrations
 
 * Edit models.py
-
 * `uv run manage.py makemigrations`
-
 * `uv run manage.py migrate`
 
 ## Environment Variables

app/admin.py

@@ -1,23 +1,30 @@
 from django.contrib import admin
-
-from .models import (CFAUser, CommonFreeResponseQuestion, EligibilityQuestion,
-                     FreeResponseQuestion, FunderConstraint, Event,
-                     CommonFollowupQuestion, FollowupQuestion, CCEmail)
-
-from django.contrib.sites.models import Site
 from django.contrib.auth.models import Group
+from django.contrib.sites.models import Site
+
+from .models import (
+    CCEmail,
+    CFAUser,
+    CommonFollowupQuestion,
+    CommonFreeResponseQuestion,
+    EligibilityQuestion,
+    Event,
+    FollowupQuestion,
+    FreeResponseQuestion,
+    FunderConstraint,
+)
 
 
 class CFAUserAdmin(admin.ModelAdmin):
-    filter_horizontal = ('cc_emails',)
-    search_fields = ('user__username',)
-    list_display = ('user', 'user_type', 'osa_email')
-    list_filter = ('user_type',)
+    filter_horizontal = ("cc_emails",)
+    search_fields = ("user__username",)
+    list_display = ("user", "user_type", "osa_email")
+    list_filter = ("user_type",)
 
 
 class EventAdmin(admin.ModelAdmin):
-    search_fields = ('name', 'requester__user__username')
-    list_filter = ('status', 'created_at')
+    search_fields = ("name", "requester__user__username")
+    list_filter = ("status", "created_at")
 
 
 admin.site.unregister(Group)

app/forms.py

@@ -1,8 +1,14 @@
 from django import forms
-from django.contrib.auth.forms import (PasswordChangeForm as BasePasswordChangeForm,
-                                       PasswordResetForm as BasePasswordResetForm,
-                                       SetPasswordForm as BaseSetPasswordForm)
-from django.core.validators import RegexValidator, EmailValidator
+from django.contrib.auth.forms import (
+    PasswordChangeForm as BasePasswordChangeForm,
+)
+from django.contrib.auth.forms import (
+    PasswordResetForm as BasePasswordResetForm,
+)
+from django.contrib.auth.forms import (
+    SetPasswordForm as BaseSetPasswordForm,
+)
+from django.core.validators import EmailValidator
 from django_registration.forms import RegistrationForm as BaseRegistrationForm
 
 from .models import Event
@@ -75,8 +81,19 @@ def save(self, commit=True):
 
     class Meta:
         model = Event
-        fields = ["name", "date", "time", "location", "contact_name", "contact_email", "contact_phone", "anticipated_attendance",
-                  "advisor_email", "advisor_phone", "organizations"]
+        fields = [
+            "name",
+            "date",
+            "time",
+            "location",
+            "contact_name",
+            "contact_email",
+            "contact_phone",
+            "anticipated_attendance",
+            "advisor_email",
+            "advisor_phone",
+            "organizations",
+        ]
         labels = {
             "name": "Event Name",
             "date": "Event Date",
@@ -91,8 +108,10 @@ class Meta:
             "contact_name": "Primary contact's name",
             "contact_email": "Primary contact's email address",
             "contact_phone": "Primary contact's phone number",
-            "anticipated_attendance": "Anticipated number of people attending the event",
+            "anticipated_attendance": (
+                "Anticipated number of people attending the event"
+            ),
             "advisor_email": "Advisor's email address",
             "advisor_phone": "Advisor's phone number",
-            "organizations": "Organization(s) involved with the event"
+            "organizations": "Organization(s) involved with the event",
         }