Merge pull request #1 from MITLibraries/create-repo-structure

Create basic repository structure

Author: hakbailey

.github/dependabot.yml

@@ -0,0 +1,18 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  # Maintain dependencies for npm
+  - package-ecosystem: "pipenv"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/pull-request-template.md

@@ -0,0 +1,39 @@
+### What does this PR do?
+
+Describe the overall purpose of the PR changes. Doesn't need to be as specific as the
+individual commits.
+
+### Helpful background context
+
+Describe any additional context beyond what the PR accomplishes if it is likely to be
+useful to a reviewer.
+
+Delete this section if it isn't applicable to the PR.
+
+### How can a reviewer manually see the effects of these changes?
+
+Explain how to see the proposed changes in the application if possible.
+
+Delete this section if it isn't applicable to the PR.
+
+### Includes new or updated dependencies?
+
+YES | NO
+
+### What are the relevant tickets?
+
+Include links to Jira Software and/or Jira Service Management tickets here.
+
+### Developer
+
+- [ ] All new ENV is documented in README (or there is none)
+- [ ] Stakeholder approval has been confirmed (or is not needed)
+
+### Code Reviewer
+
+- [ ] The commit message is clear and follows our guidelines
+      (not just this pull request message)
+- [ ] There are appropriate tests covering any new functionality
+- [ ] The documentation has been updated or is unnecessary
+- [ ] The changes have been verified
+- [ ] New dependencies are appropriate or there were no changes

.github/workflows/ci.yml

@@ -0,0 +1,7 @@
+name: CI
+on: push
+jobs:
+  test:
+    uses: mitlibraries/.github/.github/workflows/python-shared-test.yml@main
+  lint:
+    uses: mitlibraries/.github/.github/workflows/python-shared-lint.yml@main

.python-version

@@ -0,0 +1 @@
+3.9.12

Dockerfile

@@ -0,0 +1,12 @@
+FROM public.ecr.aws/lambda/python:3.9
+
+# Copy function code
+COPY . ${LAMBDA_TASK_ROOT}/
+
+# Install dependencies
+RUN pip3 install pipenv
+RUN pipenv requirements > requirements.txt
+RUN pip3 install -r requirements.txt --target "${LAMBDA_TASK_ROOT}"
+
+# Default handler. See README for how to override to a different handler.
+CMD [ "lambdas.my_function.lambda_handler" ]

Makefile

@@ -0,0 +1,40 @@
+SHELL=/bin/bash
+DATETIME:=$(shell date -u +%Y%m%dT%H%M%SZ)
+
+### Dependency commands ###
+
+install: ## Install dependencies and CLI app
+	pipenv install --dev
+
+update: install ## Update all Python dependencies
+	pipenv clean
+	pipenv update --dev
+
+### Test commands ###
+
+test: ## Run tests and print a coverage report
+	pipenv run coverage run --source=lambdas -m pytest -vv
+	pipenv run coverage report -m
+
+coveralls: test
+	pipenv run coverage lcov -o ./coverage/lcov.info
+
+### Code quality and safety commands ###
+
+lint: bandit black mypy pylama safety ## Run linting, code quality, and safety checks
+
+bandit:
+	pipenv run bandit -r lambdas
+
+black:
+	pipenv run black --check --diff .
+
+mypy:
+	pipenv run mypy lambdas
+
+pylama:
+	pipenv run pylama --options setup.cfg
+
+safety:
+	pipenv check
+	pipenv verify

Pipfile

@@ -0,0 +1,18 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+
+[dev-packages]
+bandit = "*"
+black = "*"
+coverage = "*"
+coveralls = "*"
+mypy = "*"
+pylama = {extras = ["all"], version = "*"}
+pytest = "*"
+
+[requires]
+python_version = "3.9"

README.md

@@ -0,0 +1,68 @@
+# python-lambda-template
+
+A template repository for creating Python lambda functions.
+
+## Repo setup (delete this section and above after initial function setup)
+
+1. Rename "my_function" to the desired initial function name across the repo. (May be helpful to do a project-wide find-and-replace).
+2. Update Python version if needed (note: AWS lambda cannot currently support versions higher than 3.9).
+3. Install all dependencies with `make install`  to create initial Pipfile.lock with latest dependency versions.
+4. Add initial function description to README and update initial required ENV variable documentation as needed.
+5. Update license if needed (check app-specific dependencies for licensing terms).
+6. Check Github repository settings:
+   - Confirm repo branch protection settings are correct (see [dev docs](https://mitlibraries.github.io/guides/basics/github.html) for details)
+   - Confirm that all of the following are enabled in the repo's code security and analysis settings:
+      - Dependabot alerts
+      - Dependabot security updates
+      - Secret scanning
+
+# my_function
+
+Description of the function/functions.
+
+## Development
+
+- To install with dev dependencies: `make install`
+- To update dependencies: `make update`
+- To run unit tests: `make test`
+- To lint the repo: `make lint`
+
+## Required ENV
+
+- `WORKSPACE` = Set to `dev` for local development, this will be set to `stage` and `prod` in those environments by Terraform.
+
+## Running locally
+
+<https://docs.aws.amazon.com/lambda/latest/dg/images-test.html>
+
+- Build the container:
+
+  ```bash
+  docker build -t my_function:latest .
+  ```
+
+- Run the default handler for the container:
+
+  ```bash
+  docker run -p 9000:8080 my_function:latest
+  ```
+
+- Post to the container:
+
+  ```bash
+  curl -XPOST "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{}'
+  ```
+
+- Observe output:
+
+  ```
+  "You have successfully called this lambda!"
+  ```
+
+## Running a different handler in the container
+
+If this repo contains multiple lambda functions, you can call any handler you copy into the container (see Dockerfile) by name as part of the `docker run` command:
+
+```bash
+docker run -p 9000:8080 my_function:latest lambdas.<a-different-module>.lambda_handler
+```

lambdas/__init__.py

@@ -0,0 +1 @@
+"""lambdas package."""

lambdas/my_function.py

@@ -0,0 +1,10 @@
+import json
+import logging
+
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.DEBUG)
+
+
+def lambda_handler(event: dict, context: object) -> str:  # noqa
+    logger.debug(json.dumps(event))
+    return "You have successfully called this lambda!"