Merge pull request #17 from alimkhann/features/backend-organization

Features/backend organization

Author: alimkhann

.gitignore

@@ -2,6 +2,7 @@
 *.cursorignore
 cursor-logs.md
 *.sql
+__pypackages__/
 __pycache__
 venv
 
@@ -117,6 +118,7 @@ temp/
 
 # Editor directories and files
 .vscode/*
+.DS_Store
 !.vscode/extensions.json
 .idea
 *.suo
@@ -152,4 +154,4 @@ temp/
 *.crt
 *.csr
 *.p12
-*.pfx
+*.pfx

FORDEVS.md

@@ -19,7 +19,14 @@ cd commitly-backend
 pip3 install -r requirements.txt
 ```
 ```bash
+python -m venv venv
+```
+```bash
+macOS
 source venv/bin/activate
+
+Windows
+source venv/Scripts/activate
 ```
 ```bash
 uvicorn app.main:app

commitly-backend/.flake8

@@ -0,0 +1,15 @@
+[flake8]
+application-import-names = app
+max-line-length = 88
+exclude = .git,__pycache__,venv,.venv,migrations,alembic
+
+# For Black compatibility
+extend-ignore = E203, W503, I101
+
+# import order plugin (flake8-import-order)
+import-order-style = google
+
+# flake8-quotes settings
+inline-quotes = double
+multiline-quotes = double
+docstring-quotes = double

commitly-backend/.github/workflows/ci.yml

@@ -0,0 +1,93 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - 'commitly-backend/**'
+      - '.github/workflows/ci.yml'
+  pull_request:
+    paths:
+      - 'commitly-backend/**'
+      - '.github/workflows/ci.yml'
+
+jobs:
+  lint:
+    name: Lint (Flake8, Black, isort)
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: commitly-backend
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Cache pip
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: pip-${{ runner.os }}-py312-${{ hashFiles('commitly-backend/requirements.txt', 'commitly-backend/requirements/dev.txt') }}
+          restore-keys: |
+            pip-${{ runner.os }}-py312-
+
+      - name: Install dependencies (dev)
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Flake8
+        run: |
+          echo "Running Flake8..."
+          flake8 --version
+          flake8 --verbose
+
+      - name: Black (check)
+        run: |
+          echo "Running Black..."
+          black --version
+          black --check .
+
+      - name: isort (check-only)
+        run: |
+          echo "Running isort..."
+          isort --version
+          isort --check-only --profile black .
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    needs: lint
+    defaults:
+      run:
+        working-directory: commitly-backend
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Cache pip
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: pip-${{ runner.os }}-py312-${{ hashFiles('commitly-backend/requirements.txt', 'commitly-backend/requirements/test.txt') }}
+          restore-keys: |
+            pip-${{ runner.os }}-py312-
+
+      - name: Install dependencies (dev)
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Run pytest
+        run: |
+          pytest -q
+

commitly-backend/alembic/env.py

@@ -7,13 +7,13 @@
 from alembic import context
 from sqlalchemy import engine_from_config, pool
 
+from app.core.config import settings
+from app.core.database import Base
+
 PROJECT_ROOT = Path(__file__).resolve().parents[1]
 if str(PROJECT_ROOT) not in sys.path:
     sys.path.append(str(PROJECT_ROOT))
 
-from app.core.config import settings  # noqa: E402
-from app.core.database import Base  # noqa: E402
-
 config = context.config
 
 if config.config_file_name is not None:

commitly-backend/alembic/versions/6b3b2a7f804c_create_waitlist_and_support_tables.py

@@ -11,7 +11,6 @@
 from alembic import op
 import sqlalchemy as sa
 
-
 revision: str = "6b3b2a7f804c"
 down_revision: Union[str, Sequence[str], None] = None
 branch_labels: Union[str, Sequence[str], None] = None
@@ -23,7 +22,9 @@ def upgrade() -> None:
         "waitlist",
         sa.Column("id", sa.Integer(), primary_key=True),
         sa.Column("email", sa.String(length=255), nullable=False),
-        sa.Column("source", sa.String(length=100), nullable=False, server_default="landing"),
+        sa.Column(
+            "source", sa.String(length=100), nullable=False, server_default="landing"
+        ),
         sa.Column(
             "created_at",
             sa.TIMESTAMP(timezone=True),
@@ -60,7 +61,9 @@ def upgrade() -> None:
         DO $$
         BEGIN
             IF NOT EXISTS (
-                SELECT 1 FROM pg_policies WHERE schemaname = 'public' AND tablename = 'waitlist' AND policyname = 'Allow public insert on waitlist'
+                SELECT 1 FROM pg_policies WHERE schemaname = 'public'
+                AND tablename = 'waitlist'
+                AND policyname = 'Allow public insert on waitlist'
             ) THEN
                 CREATE POLICY "Allow public insert on waitlist"
                 ON waitlist FOR INSERT
@@ -75,7 +78,9 @@ def upgrade() -> None:
         DO $$
         BEGIN
             IF NOT EXISTS (
-                SELECT 1 FROM pg_policies WHERE schemaname = 'public' AND tablename = 'waitlist' AND policyname = 'Allow public select count on waitlist'
+                SELECT 1 FROM pg_policies WHERE schemaname = 'public'
+                AND tablename = 'waitlist'
+                AND policyname = 'Allow public select count on waitlist'
             ) THEN
                 CREATE POLICY "Allow public select count on waitlist"
                 ON waitlist FOR SELECT
@@ -90,7 +95,9 @@ def upgrade() -> None:
         DO $$
         BEGIN
             IF NOT EXISTS (
-                SELECT 1 FROM pg_policies WHERE schemaname = 'public' AND tablename = 'support' AND policyname = 'Allow public insert on support'
+                SELECT 1 FROM pg_policies WHERE schemaname = 'public'
+                AND tablename = 'support'
+                AND policyname = 'Allow public insert on support'
             ) THEN
                 CREATE POLICY "Allow public insert on support"
                 ON support FOR INSERT
@@ -105,7 +112,9 @@ def upgrade() -> None:
         DO $$
         BEGIN
             IF NOT EXISTS (
-                SELECT 1 FROM pg_policies WHERE schemaname = 'public' AND tablename = 'support' AND policyname = 'Allow public select on support'
+                SELECT 1 FROM pg_policies WHERE schemaname = 'public'
+                AND tablename = 'support'
+                AND policyname = 'Allow public select on support'
             ) THEN
                 CREATE POLICY "Allow public select on support"
                 ON support FOR SELECT
@@ -134,10 +143,12 @@ def upgrade() -> None:
 def downgrade() -> None:
     op.execute("DROP FUNCTION IF EXISTS public.waitlist_count();")
 
-    op.execute("DROP POLICY IF EXISTS \"Allow public insert on support\" ON support;")
-    op.execute("DROP POLICY IF EXISTS \"Allow public select on support\" ON support;")
-    op.execute("DROP POLICY IF EXISTS \"Allow public insert on waitlist\" ON waitlist;")
-    op.execute("DROP POLICY IF EXISTS \"Allow public select count on waitlist\" ON waitlist;")
+    op.execute('DROP POLICY IF EXISTS "Allow public insert on support" ON support;')
+    op.execute('DROP POLICY IF EXISTS "Allow public select on support" ON support;')
+    op.execute('DROP POLICY IF EXISTS "Allow public insert on waitlist" ON waitlist;')
+    op.execute(
+        'DROP POLICY IF EXISTS "Allow public select count on waitlist" ON waitlist;'
+    )
 
     op.drop_index("ix_support_status", table_name="support")
     op.drop_index("ix_support_email", table_name="support")

commitly-backend/alembic/versions/9d1e2f3a_drop_support_feature.py

@@ -11,7 +11,6 @@
 from alembic import op
 import sqlalchemy as sa
 
-
 revision: str = "9d1e2f3a"
 down_revision: Union[str, Sequence[str], None] = "6b3b2a7f804c"
 branch_labels: Union[str, Sequence[str], None] = None
@@ -25,12 +24,16 @@ def upgrade() -> None:
         DO $$
         BEGIN
             IF EXISTS (
-                SELECT 1 FROM pg_policies WHERE schemaname = 'public' AND tablename = 'support' AND policyname = 'Allow public insert on support'
+                SELECT 1 FROM pg_policies WHERE schemaname = 'public'
+                AND tablename = 'support'
+                AND policyname = 'Allow public insert on support'
             ) THEN
                 DROP POLICY "Allow public insert on support" ON public.support;
             END IF;
             IF EXISTS (
-                SELECT 1 FROM pg_policies WHERE schemaname = 'public' AND tablename = 'support' AND policyname = 'Allow public select on support'
+                SELECT 1 FROM pg_policies WHERE schemaname = 'public'
+                AND tablename = 'support'
+                AND policyname = 'Allow public select on support'
             ) THEN
                 DROP POLICY "Allow public select on support" ON public.support;
             END IF;
@@ -74,7 +77,9 @@ def downgrade() -> None:
         DO $$
         BEGIN
             IF NOT EXISTS (
-                SELECT 1 FROM pg_policies WHERE schemaname = 'public' AND tablename = 'support' AND policyname = 'Allow public insert on support'
+                SELECT 1 FROM pg_policies WHERE schemaname = 'public'
+                AND tablename = 'support'
+                AND policyname = 'Allow public insert on support'
             ) THEN
                 CREATE POLICY "Allow public insert on support"
                 ON support FOR INSERT
@@ -90,7 +95,9 @@ def downgrade() -> None:
         DO $$
         BEGIN
             IF NOT EXISTS (
-                SELECT 1 FROM pg_policies WHERE schemaname = 'public' AND tablename = 'support' AND policyname = 'Allow public select on support'
+                SELECT 1 FROM pg_policies WHERE schemaname = 'public'
+                AND tablename = 'support'
+                AND policyname = 'Allow public select on support'
             ) THEN
                 CREATE POLICY "Allow public select on support"
                 ON support FOR SELECT
@@ -99,4 +106,4 @@ def downgrade() -> None:
         END
         $$;
         """
-    )
+    )

commitly-backend/app/api/donate.py

@@ -3,7 +3,7 @@
 from fastapi import APIRouter, HTTPException, status
 from pydantic import BaseModel, EmailStr, Field
 
-from app.services.polar import PolarService, PolarConfigurationError
+from app.services.polar import PolarConfigurationError, PolarService
 
 router = APIRouter()
 
@@ -18,15 +18,26 @@ class DonateResponse(BaseModel):
     url: str
 
 
-@router.post("/checkout", response_model=DonateResponse, status_code=status.HTTP_201_CREATED)
+@router.post(
+    "/checkout", response_model=DonateResponse, status_code=status.HTTP_201_CREATED
+)
 def create_donation_checkout(payload: DonateRequest) -> DonateResponse:
     try:
         service = PolarService()
-        result = service.create_checkout(amount_cents=payload.amount_cents, email=payload.email)
+        result = service.create_checkout(
+            amount_cents=payload.amount_cents, email=payload.email
+        )
         return DonateResponse(checkout_id=result["id"], url=result["url"])
     except PolarConfigurationError as exc:
-        raise HTTPException(status_code=status.HTTP_503_SERVICE_UNAVAILABLE, detail=str(exc))
+        raise HTTPException(
+            status_code=status.HTTP_503_SERVICE_UNAVAILABLE, detail=str(exc)
+        )
     except ValueError as exc:
-        raise HTTPException(status_code=status.HTTP_422_UNPROCESSABLE_ENTITY, detail=str(exc))
+        raise HTTPException(
+            status_code=status.HTTP_422_UNPROCESSABLE_ENTITY, detail=str(exc)
+        )
     except Exception as exc:  # noqa: BLE001
-        raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, detail="Failed to create donation checkout") from exc
+        raise HTTPException(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+            detail="Failed to create donation checkout",
+        ) from exc

commitly-backend/app/api/waitlist.py

@@ -2,7 +2,7 @@
 from sqlalchemy.orm import Session
 
 from app.core.database import get_db
-from app.models.waitlist import WaitlistCreate, WaitlistResponse, WaitlistCountResponse
+from app.models.waitlist import WaitlistCountResponse, WaitlistCreate, WaitlistResponse
 from app.services.supabase import DuplicateEntryError, PersistenceError, SupabaseService
 
 router = APIRouter()
@@ -13,7 +13,9 @@
     response_model=WaitlistResponse,
     status_code=status.HTTP_201_CREATED,
 )
-def join_waitlist(payload: WaitlistCreate, session: Session = Depends(get_db)) -> WaitlistResponse:
+def join_waitlist(
+    payload: WaitlistCreate, session: Session = Depends(get_db)
+) -> WaitlistResponse:
     service = SupabaseService(session)
     try:
         entry = service.add_to_waitlist(payload)
@@ -23,7 +25,9 @@ def join_waitlist(payload: WaitlistCreate, session: Session = Depends(get_db)) -
             detail="This email is already on the waitlist.",
         )
     except PersistenceError as exc:
-        raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, detail=str(exc))
+        raise HTTPException(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, detail=str(exc)
+        )
 
     return WaitlistResponse.model_validate(entry)
 
@@ -34,6 +38,8 @@ def get_waitlist_count(session: Session = Depends(get_db)) -> WaitlistCountRespo
     try:
         count = service.waitlist_count()
     except PersistenceError as exc:
-        raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, detail=str(exc))
+        raise HTTPException(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, detail=str(exc)
+        )
 
     return WaitlistCountResponse(count=count)