Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/techjacker/python-serverless-api
Boilerplate flask app that is portable between different serverless platforms (AWS, Azure, GCP).
https://github.com/techjacker/python-serverless-api
aws-lambda azure-functions flask google-functions python serverless
Last synced: about 2 months ago
JSON representation
Boilerplate flask app that is portable between different serverless platforms (AWS, Azure, GCP).
- Host: GitHub
- URL: https://github.com/techjacker/python-serverless-api
- Owner: techjacker
- License: mit
- Created: 2018-04-11T16:18:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-15T21:32:37.000Z (almost 2 years ago)
- Last Synced: 2024-04-11T20:36:51.493Z (9 months ago)
- Topics: aws-lambda, azure-functions, flask, google-functions, python, serverless
- Language: Shell
- Homepage: https://andrewgriffithsonline.com/blog/180412-deploy-flask-api-any-serverless-cloud-platform
- Size: 35.2 KB
- Stars: 25
- Watchers: 4
- Forks: 9
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Python Serverless API
Boilerplate Flask app that is portable between different serverless platforms.
-----------------------------------------------------------
## Platforms
Deployment and application code adaptors are being added for the following:
| Platform | Deployment | Status |
|--------------------------|-----------------------|:----------------------:|
| AWS Lambda | AWS SAM | :heavy_check_mark: |
| AWS Lambda | Terraform | :heavy_check_mark: |
| Azure Functions | Terraform | |
| Google Cloud Functions | Terraform | |
| Google Kubernetes Engine | `gcloud` & `kubectl` | |
| Platform | Adaptor | Code/Config |
|--------------------------|-----------------------|:----------------------:|
| Local Development | None | [:floppy_disk:](run.py) |
| AWS Lambda Python >= 3.6 | [Flask-Lambda-Python36](https://github.com/techjacker/flask-lambda) | [:floppy_disk:](run_lambda.py)|
| AWS Lambda Python <= 3.6 | [Flask-Lambda](https://github.com/sivel/flask-lambda) | [:floppy_disk:](run_lambda.py) |
| Azure Functions | | |
| Google Cloud Functions | | |
-----------------------------------------------------------
## Setup
#### 1. Create `.env` file and update contents
This is used to set the environment variables required for deployment and local development.
```
$ cp .env.example .env
$ vim .env
```
#### 2. Create a virtualenv then install requirements:
```
$ make env
$ source env/bin/activate
$ make deps
```
-----------------------------------------------------------
## Example Usage
#### 1. Set Environment
Ensure you have created your virtualenv and have the necessary environment variables set (see [setup instructions](#setup) above).
```
$ source env/bin/activate
$ source .env
```
#### 2. Run server
##### On host
```
$ make server-debug
```
##### In docker
```
$ docker-compose up
```
#### 3. Manually test development server
```
$ http-prompt localhost:5000
GET /artists
```
-----------------------------------------------------------
## AWS Lambda
### Terraform Deployment
Ensure you have created your virtualenv and have the necessary environment variables set (see [setup instructions](#setup) above).
##### Setup
Create terraform state bucket.
```
$ aws s3 mb --region eu-west-2 s3://
```
Update bucket name in `/terraform/main.tf`.
```
terraform {
backend "s3" {
bucket = ""
key = "terraform.tfstate"
region = "eu-west-2"
}
}
```
#### Deploy
Bundle the app into a zip and deploy it using terraform.
```
$ ./bin/deploy
```
#### Manually Test API
```
$ http-prompt $(cd terraform && terraform output api_url)
GET artists
```
### [AWS Serverless Application Model (SAM)](https://aws.amazon.com/about-aws/whats-new/2016/11/introducing-the-aws-serverless-application-model/) Deployment
Unlike Terraform SAM doesn't upload the zip bundle so do this using the `aws-cli` tool.
```Shell
$ aws s3 mb s3://
$ aws s3 cp terraform/dist/python-serverless-api.zip s3:///python-serverless-api.zip
```
Update the S3 bucket value in the SAM config.
```YAML
# template.yaml
AWSTemplateFormatVersion: '2010-09-09'
Transform: 'AWS::Serverless-2016-10-31'
Description: 'Boilerplate Python 3.6 Flask App.'
Resources:
FlaskAPI:
Type: 'AWS::Serverless::Function'
Properties:
CodeUri: s3:///flask-app.zip
```
Deploy the SAM template with Cloudformation.
```Shell
$ aws cloudformation deploy \
--template-file template.yaml \
--stack-name python-serverless-stack-sam
--capabilities CAPABILITY_IAM
```
-----------------------------------------------------------
## Test
```
$ make test
$ make lint
```