Run GH-Action PR-Checks on merge; also show GH-Action badges (#113)

* run PR Checks on merge to catch "ships-passing-in-the-night" issues

* add Github Action badges for PR Checks and CI-CD workflows

* fix broken pandas import into dev environment for generate_conversation/chat.py

Author: yangm2

.github/workflows/pr-check.yml

@@ -2,10 +2,12 @@ name: PR Checks
 
 on:
   pull_request:
-    types: [opened, synchronize, reopened]
+    types: [opened, synchronize, reopened, closed]
 
 jobs:
   backend-test:
+    # skip this check for closed PRs that are not merged
+    if: ${{ github.event.action != 'closed' || github.event.pull_request.merged == true }}
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -44,6 +46,8 @@ jobs:
         run: uv run pytest -v -s
 
   frontend-build:
+    # skip this check for closed PRs that are not merged
+    if: ${{ github.event.action != 'closed' || github.event.pull_request.merged == true }}
     runs-on: ubuntu-latest
     defaults:
       run:

README.md

@@ -6,6 +6,9 @@ Live at https://tenantfirstaid.com/
 
 ## Local Development
 
+[![PR Checks](https://github.com/codeforpdx/tenantfirstaid/actions/workflows/pr-check.yml/badge.svg)](https://github.com/codeforpdx/tenantfirstaid/actions/workflows/pr-check.yml)
+[![CI-CD](https://github.com/codeforpdx/tenantfirstaid/actions/workflows/deploy.yml/badge.svg)](https://github.com/codeforpdx/tenantfirstaid/actions/workflows/deploy.yml)
+
 ### Prerequisites
  - [uv](https://docs.astral.sh/uv/getting-started/installation/)
  - [docker](https://www.docker.com/)

backend/pyproject.toml

@@ -11,7 +11,8 @@ dependencies = [
   "simplejson",
   "ipdb>=0.13.13",
   "python-dotenv",
-  ]
+  "pandas>=2.3.0",
+]
 
 [tool.setuptools.packages.find]
 where = ["."]

backend/scripts/generate_conversation/chat.py

@@ -1,9 +1,17 @@
+# /// script
+# requires-python = "~=3.11"
+# dependencies = [
+#     "openai",
+#     "pandas",
+# ]
+# ///
 from openai import OpenAI
 import os
 import ast
 import argparse
 from pathlib import Path
 import pandas as pd
+from typing import Self
 
 
 BOT_INSTRUCTIONS = """Pretend you're a legal expert who giving advice about eviction notices in Oregon. 
@@ -36,12 +44,13 @@
 
 
 class ChatView:
-    client = OpenAI(
-        api_key=API_KEY,
-        base_url=BASE_URL,
-    )
+    client: Self
 
     def __init__(self, starting_message, user_facts):
+        self.client = OpenAI(
+            api_key=API_KEY,
+            base_url=BASE_URL,
+        )
         VECTOR_STORE_ID = os.getenv("VECTOR_STORE_ID")
         NUM_FILE_SEARCH_RESULTS = os.getenv("NUM_FILE_SEARCH_RESULTS", 10)
         self.input_messages = [{"role": "user", "content": starting_message}]