marc/lambda-boilerplate
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
This repository has been archived on 2024-07-19. You can view files and clone it, but cannot push or open issues or pull requests.
lambda-boilerplate/README.md

35 lines
2 KiB
Markdown
Raw Normal View History

Initial commit
2020-08-23 05:43:53 +00:00
# lambda-boilerplate
🛠 Skip the boilerplate and start building fun λ things 🛠
Initial version (#1) * infra: python, bootstrap * feat: local sample * infra: invocations and CFN * docs: stub * wip: clean up, add sceptre * wip: add app stack teardown * refactor: template rejigging * chore: ignore outfiles * wip: cleanup post upload to s3 * wip: teardown infra task * docs: links, contrib * docs: missing command * docs: formatting
2020-09-26 05:14:56 +00:00
ci: base (#2) * ci: base * ci: missing bit * ci: pyenv via action * ci: typos * ci: deps * ci: typo * ci: temp rm black * ci: py ver * ci: use builtin py * ci: typo * ci: setuptools * ci: without subshell * chore: normalize titles * chore: lint * ci: validate and lint flows * ci: job name * ci: pipx as module * ci: missing dep * ci: missing dep * ci: pipx module * docs: add badge
2020-09-26 15:40:18 +00:00
![Lambda Boilerplate](https://github.com/mcataford/lambda-boilerplate/workflows/Lambda%20Boilerplate/badge.svg)
Initial version (#1) * infra: python, bootstrap * feat: local sample * infra: invocations and CFN * docs: stub * wip: clean up, add sceptre * wip: add app stack teardown * refactor: template rejigging * chore: ignore outfiles * wip: cleanup post upload to s3 * wip: teardown infra task * docs: links, contrib * docs: missing command * docs: formatting
2020-09-26 05:14:56 +00:00
## Overview
Migrate to Terraform (#3) * infra: exit sceptre, enter terraform infra: ignores, vars * infra: tweaks * ci: remove sceptre validation * ci: bootstrap * build: deps * ci: py setup * docs: add docs to tasks * docs: update
2021-03-19 17:38:54 +00:00
AWS Lambdas are fun, but often the amount of boilerplate involved in getting a project off the ground hinders the fun. From setting up a local environment to writing out infrastructure templates, the overhead of Lambda-based greenfield projects can be daunting. No more. Just use this repository as a template or clone it and jump straight into the action! This repository offers a quick template your can use, full with a Docker setup for local development and invocation commands that you can use to package and deploy Lambda-based apps.
Initial version (#1) * infra: python, bootstrap * feat: local sample * infra: invocations and CFN * docs: stub * wip: clean up, add sceptre * wip: add app stack teardown * refactor: template rejigging * chore: ignore outfiles * wip: cleanup post upload to s3 * wip: teardown infra task * docs: links, contrib * docs: missing command * docs: formatting
2020-09-26 05:14:56 +00:00
## Local development
To get started, hit the bootstrap script with `. script/bootstrap`. This will set up a Python 3.8 virtualenv set up with some basic tools that will make your life easier.
Migrate to Terraform (#3) * infra: exit sceptre, enter terraform infra: ignores, vars * infra: tweaks * ci: remove sceptre validation * ci: bootstrap * build: deps * ci: py setup * docs: add docs to tasks * docs: update
2021-03-19 17:38:54 +00:00
The base Lambda handler is at `src/base.py` and all the Terraform configurations are in `infrastructure`.
Initial version (#1) * infra: python, bootstrap * feat: local sample * infra: invocations and CFN * docs: stub * wip: clean up, add sceptre * wip: add app stack teardown * refactor: template rejigging * chore: ignore outfiles * wip: cleanup post upload to s3 * wip: teardown infra task * docs: links, contrib * docs: missing command * docs: formatting
2020-09-26 05:14:56 +00:00
Migrate to Terraform (#3) * infra: exit sceptre, enter terraform infra: ignores, vars * infra: tweaks * ci: remove sceptre validation * ci: bootstrap * build: deps * ci: py setup * docs: add docs to tasks * docs: update
2021-03-19 17:38:54 +00:00
[Read more about Sceptre](https://sceptre.cloudreach.com/latest/index.html://www.terraform.io/docs/index.html)
Initial version (#1) * infra: python, bootstrap * feat: local sample * infra: invocations and CFN * docs: stub * wip: clean up, add sceptre * wip: add app stack teardown * refactor: template rejigging * chore: ignore outfiles * wip: cleanup post upload to s3 * wip: teardown infra task * docs: links, contrib * docs: missing command * docs: formatting
2020-09-26 05:14:56 +00:00
[Read more about AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/lambda-python.html)
### Invocations
This template uses PyInvoke, all commands are of the format `inv <command> <parameters>`.
Migrate to Terraform (#3) * infra: exit sceptre, enter terraform infra: ignores, vars * infra: tweaks * ci: remove sceptre validation * ci: bootstrap * build: deps * ci: py setup * docs: add docs to tasks * docs: update
2021-03-19 17:38:54 +00:00
Use `inv --list` for the full list of commands.
Initial version (#1) * infra: python, bootstrap * feat: local sample * infra: invocations and CFN * docs: stub * wip: clean up, add sceptre * wip: add app stack teardown * refactor: template rejigging * chore: ignore outfiles * wip: cleanup post upload to s3 * wip: teardown infra task * docs: links, contrib * docs: missing command * docs: formatting
2020-09-26 05:14:56 +00:00
## Deployment
Migrate to Terraform (#3) * infra: exit sceptre, enter terraform infra: ignores, vars * infra: tweaks * ci: remove sceptre validation * ci: bootstrap * build: deps * ci: py setup * docs: add docs to tasks * docs: update
2021-03-19 17:38:54 +00:00
Deployment is in three steps: on first setup, you will need to make sure that your `bootstrap` environment is ready via `inv cloud.apply bootstrap`. Then, you should upload your lambdas' source with `inv cloud.pack` and `inv cloud.push`. Finally, you can deploy your application resources with `inv cloud.deploy app`.
Initial version (#1) * infra: python, bootstrap * feat: local sample * infra: invocations and CFN * docs: stub * wip: clean up, add sceptre * wip: add app stack teardown * refactor: template rejigging * chore: ignore outfiles * wip: cleanup post upload to s3 * wip: teardown infra task * docs: links, contrib * docs: missing command * docs: formatting
2020-09-26 05:14:56 +00:00
## Contributing
Got suggestions or improvements you'd like to make? Open a PR or [an issue](https://github.com/mcataford/lambda-boilerplate/issues)!
Feature requests should keep in mind that the goal of this boilerplate is to be general enough so that the cost of tailoring it to specific use cases is low.
Reference in a new issue Copy permalink