Merge pull request #60 from MITLibraries/IN-1542-uv-and-new-devops-conventions

IN-1542 - Overhaul of lambda template to uv and updated devops conventions

Author: ghukill

.aws-architecture

@@ -0,0 +1 @@
+linux/arm64

.github/pull-request-template.md

@@ -16,4 +16,4 @@ YES | NO
 - Include links to Jira Software and/or Jira Service Management tickets here.
 
 ### Code review
-* Code review best practices are documented [here](https://mitlibraries.github.io/guides/collaboration/code_review.html) and you are encouraged to have a constructive dialogue with your reviewers about their preferences and expectations.
+* Code review best practices are documented [here](https://mitlibraries.github.io/guides/collaboration/code_review.html) and you are encouraged to have a constructive dialogue with your reviewers about their preferences and expectations.

.github/workflows/ci.yml

@@ -1,7 +1,11 @@
 name: CI
-on: push
+permissions: read-all
+on:
+  pull_request:
+    paths-ignore:
+      - '.github/**'
 jobs:
   test:
-    uses: mitlibraries/.github/.github/workflows/python-shared-test.yml@main
+    uses: mitlibraries/.github/.github/workflows/python-uv-shared-test.yml@main
   lint:
-    uses: mitlibraries/.github/.github/workflows/python-shared-lint.yml@main
+    uses: mitlibraries/.github/.github/workflows/python-uv-shared-lint.yml@main

.gitignore

@@ -136,4 +136,8 @@ dmypy.json
 .vscode/
 
 # jetbrains
-.idea/
+.idea/
+
+.arch_tag
+.aws-sam/
+tests/sam/env.json

.pre-commit-config.yaml

@@ -1,29 +1,28 @@
 default_language_version:
-  python: python3.12 # set for project python version
+  python: python3.13
+default_stages:
+  - pre-push
 repos:
   - repo: local
     hooks:
-      - id: black-apply
-        name: black-apply
-        entry: pipenv run black
+      - id: ruff-format
+        name: ruff-format
+        entry: uv run ruff format --diff
         language: system
         pass_filenames: true
-        types: ["python"]
+        types: [ "python" ]
+
       - id: mypy
         name: mypy
-        entry: pipenv run mypy
+        entry: uv run mypy
         language: system
         pass_filenames: true
-        types: ["python"]
-        exclude: "tests/"
-      - id: ruff-apply
-        name: ruff-apply
-        entry: pipenv run ruff check --fix
+        types: [ "python" ]
+        exclude: "(tests/|output/|migrations/)"
+
+      - id: ruff-check
+        name: ruff-check
+        entry: uv run ruff check
         language: system
         pass_filenames: true
-        types: ["python"]
-      - id: pip-audit
-        name: pip-audit
-        entry: pipenv run pip-audit
-        language: system
-        pass_filenames: false
+        types: [ "python" ]

.python-version

@@ -1 +1 @@
-3.12
+3.13

Dockerfile

@@ -1,12 +1,18 @@
-FROM public.ecr.aws/lambda/python:3.12
+FROM public.ecr.aws/lambda/python:3.13
 
-# Copy function code
-COPY . ${LAMBDA_TASK_ROOT}/
+# Install uv
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+
+# Copy project metadata
+COPY pyproject.toml uv.lock* ./
 
 # Install dependencies
-RUN pip3 install pipenv
-RUN pipenv requirements > requirements.txt
-RUN pip3 install -r requirements.txt --target "${LAMBDA_TASK_ROOT}"
+RUN cd ${LAMBDA_TASK_ROOT} && \
+    uv export --format requirements-txt --no-hashes --no-dev > requirements.txt && \
+    uv pip install -r requirements.txt --target "${LAMBDA_TASK_ROOT}" --system
+
+# Copy project files
+COPY . ${LAMBDA_TASK_ROOT}/
 
 # Default handler. See README for how to override to a different handler.
 CMD [ "lambdas.my_function.lambda_handler" ]

Makefile

@@ -5,53 +5,75 @@ help: # Preview Makefile commands
 	@awk 'BEGIN { FS = ":.*#"; print "Usage:  make <target>\n\nTargets:" } \
 /^[-_[:alpha:]]+:.?*#/ { printf "  %-15s%s\n", $$1, $$2 }' $(MAKEFILE_LIST)
 
-#######################
-# Dependency commands
-#######################
+# ensure OS binaries aren't called if naming conflict with Make recipes
+.PHONY: help install venv update test coveralls lint lint-fix security sam-build sam-http-run sam-http-ping sam-invoke
 
-install: # Install Python dependencies
-	pipenv install --dev
-	pipenv run pre-commit install
+##############################################
+# Python Environment and Dependency commands
+##############################################
 
-update: install # Update Python dependencies
-	pipenv clean
-	pipenv update --dev
+install: .venv .git/hooks/pre-commit .git/hooks/pre-push # Install Python dependencies and create virtual environment if not exists
+	uv sync --dev
+
+.venv: # Creates virtual environment if not found
+	@echo "Creating virtual environment at .venv..."
+	uv venv .venv
+
+.git/hooks/pre-commit: # Sets up pre-commit commit hooks if not setup
+	@echo "Installing pre-commit commit hooks..."
+	uv run pre-commit install --hook-type pre-commit
+
+.git/hooks/pre-push: # Sets up pre-commit push hooks if not setup
+	@echo "Installing pre-commit push hooks..."
+	uv run pre-commit install --hook-type pre-push
+
+venv: .venv # Create the Python virtual environment
+
+update: # Update Python dependencies
+	uv lock --upgrade
+	uv sync --dev
 
 ######################
 # Unit test commands
 ######################
 
 test: # Run tests and print a coverage report
-	pipenv run coverage run --source=lambdas -m pytest -vv
-	pipenv run coverage report -m
+	uv run coverage run --source=lambdas -m pytest -vv
+	uv run coverage report -m
 
 coveralls: test # Write coverage data to an LCOV report
-	pipenv run coverage lcov -o ./coverage/lcov.info
+	uv run coverage lcov -o ./coverage/lcov.info
 
 ####################################
-# Code quality and safety commands
+# Code linting and formatting
 ####################################
 
-lint: black mypy ruff safety # Run linters
-
-black: # Run 'black' linter and print a preview of suggested changes
-	pipenv run black --check --diff .
+lint: # Run linting, alerts only, no code changes
+	uv run ruff format --diff
+	uv run mypy .
+	uv run ruff check .
 
-mypy: # Run 'mypy' linter
-	pipenv run mypy .
+lint-fix: # Run linting, auto fix behaviors where supported
+	uv run ruff format .
+	uv run ruff check --fix .
 
-ruff: # Run 'ruff' linter and print a preview of errors
-	pipenv run ruff check .
+security: # Run security / vulnerability checks
+	uv run pip-audit
 
-safety: # Check for security vulnerabilities and verify Pipfile.lock is up-to-date
-	pipenv run pip-audit
-	pipenv verify
+####################################
+# SAM Lambda
+####################################
+sam-build: # SAM: Build SAM image for running Lambda locally
+	sam build --template tests/sam/template.yaml
 
-lint-apply: # Apply changes with 'black' and resolve 'fixable errors' with 'ruff'
-	black-apply ruff-apply 
+sam-http-run: # SAM: Run lambda locally as an HTTP server
+	sam local start-api --template tests/sam/template.yaml --env-vars tests/sam/env.json
 
-black-apply: # Apply changes with 'black'
-	pipenv run black .
+sam-http-ping: # SAM: Send curl command to SAM HTTP server
+	curl --location 'http://localhost:3000/myfunction' \
+	--header 'Content-Type: application/json' \
+	--data '{"msg":"in a bottle"}'
 
-ruff-apply: # Resolve 'fixable errors' with 'ruff'
-	pipenv run ruff check --fix .
+sam-invoke: # SAM: Invoke lambda directly
+	echo '{"msg":"in a bottle"}' \
+	| sam local invoke -e -