instructions for Python checks, now with more checks enabled (#109)

* add make-targets and instructions for Python checks; fix GH-action warning

* formatting

* removing file as per 6/11 meeting, resolves #104

* this script seems to be obsolete since #73 moved the constant into a JSON file

* format/lint changes

* enable lint and type checking for Python

Author: yangm2

.github/workflows/pr-check.yml

@@ -18,7 +18,7 @@ jobs:
         uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
-          cache-dependency-glob: "uv.lock"
+          cache-dependency-glob: "backend/uv.lock"
           # Install a specific version of uv.
           version: "0.7.12"
 
@@ -31,6 +31,12 @@ jobs:
       - name: Run formatter checks
         run: uv run ruff format --check
 
+      - name: Run lint checks
+        run: uv run ruff check
+
+      - name: Run type checks
+        run: uv run ty check
+
       - name: Run tests
         env:
           OPENAI_API_KEY: XXXX

README.md

@@ -23,9 +23,50 @@ Live at https://tenantfirstaid.com/
 1. Go to http://localhost:5173
 1. Start chatting
 
-### Run backend tests
+### Backend Development & Checks
 
-In the `backend/` directory, run `uv run pytest`
+1. change to the `backend/` directory
+   ```sh
+   % cd backend
+   ```
+  - run individual checks
+    1. *format* Python code with `ruff`
+       ```sh
+       % uv run ruff format
+       ```
+       or
+       ```sh
+       % make fmt
+       ```
+    1. *lint* Python code with `ruff`
+       ```sh
+       % uv run ruff check
+       ```
+       or
+       ```sh
+       % make lint
+       ```
+    1. *typecheck* Python code with `ty`
+       ```sh
+       % uv run ty check
+       ```
+       or
+       ```sh
+       % make typecheck
+       ```
+    1. *test* Python code with `pytest`
+       ```sh
+       % uv run pytest
+       ```
+       or
+       ```sh
+       % make test
+       ```
+  - or run the above checks in one-shot
+    ```sh
+    % make --keep-going check
+    ```
+    `--keep-going` will continue to run checks, even if previous `make` rule fail.  Omit if you want to stop after the first `make` rule fails.
 
 ## Contributing
 

backend/Makefile

@@ -5,14 +5,26 @@ PIP := $(PYTHON) pip
 
 all: check
 
+uv.lock: pyproject.toml
+	$(PYTHON) sync
+
 install:
 	$(PIP) install .
 
-test:
-	uv run pytest -v -s
+fmt: uv.lock
+	$(PYTHON) run ruff format
+
+lint: uv.lock
+	$(PYTHON) run ruff check $(LINT_OPTIONS)
+
+typecheck: uv.lock
+	$(PYTHON) run ty check $(TYPECHECK_OPTIONS)
+
+test: uv.lock
+	uv run pytest -v -s $(TEST_OPTIONS)
 
 clean:
 	find . -type d -name '__pycache__' -exec rm -r {} +
 	rm -rf dist build *.egg-info
 
-check: clean install test
+check: clean install fmt lint typecheck test

backend/scripts/eval.py

@@ -1,4 +1,6 @@
-import textwrap, pathlib, json
+import textwrap
+import pathlib
+import json
 
 # Build the two eval samples as Python dicts
 samples = [