Serverless plugin to deploy WSGI applications (Flask/Django/Pyramid etc.) and bundle Python packages
JavaScript Python
Clone or download
Permalink
Failed to load latest commit information.
.eslintrc.js Prettier Jul 3, 2018
.flake8 Format code using black Jul 2, 2018
.gitignore Additional PyPI configuration Aug 2, 2018
.travis.yml Update Travis node versions Jul 3, 2018
CHANGELOG.md Split request mapping code into separate module for publishing to PyPI. Aug 2, 2018
LICENSE Initial commit Oct 13, 2016
MANIFEST.in Split request mapping code into separate module for publishing to PyPI. Aug 2, 2018
README.md Split request mapping code into separate module for publishing to PyPI. Aug 2, 2018
index.js Split request mapping code into separate module for publishing to PyPI. Aug 2, 2018
index.test.js Split request mapping code into separate module for publishing to PyPI. Aug 2, 2018
package-lock.json Improve detection of available Python executable and associated error… Jul 30, 2018
package.json Split request mapping code into separate module for publishing to PyPI. Aug 2, 2018
requirements.py Format code using black Jul 2, 2018
requirements.txt Initial working plugin Oct 13, 2016
requirements_test.py Format code using black Jul 2, 2018
serve.py Start multithreaded server when running `sls wsgi serve`. Closes #69 Jul 30, 2018
serve_test.py Start multithreaded server when running `sls wsgi serve`. Closes #69 Jul 30, 2018
serverless_wsgi.py Split request mapping code into separate module for publishing to PyPI. Aug 2, 2018
setup.cfg Additional PyPI configuration Aug 2, 2018
setup.py Split request mapping code into separate module for publishing to PyPI. Aug 2, 2018
wsgi.py Split request mapping code into separate module for publishing to PyPI. Aug 2, 2018
wsgi_test.py Add support for defining additional text mime types. Closes #68 Jul 29, 2018

README.md

Serverless WSGI

npm package

serverless Build Status Coverage Status Dependency Status Dev Dependency Status

A Serverless v1.x plugin to build your deploy Python WSGI applications using Serverless. Compatible WSGI application frameworks include Flask, Django and Pyramid - for a complete list, see: http://wsgi.readthedocs.io/en/latest/frameworks.html.

Features

  • Transparently converts API Gateway requests to and from standard WSGI requests
  • Supports anything you'd expect from WSGI such as redirects, cookies, file uploads etc.
  • Automatically downloads Python packages that you specify in requirements.txt and deploys them along with your application
  • Convenient wsgi serve command for serving your application locally during development

Install

npm install --save serverless-wsgi

Add the plugin to your serverless.yml file and set the WSGI application:

plugins:
  - serverless-wsgi

Flask configuration example

This example assumes that you have intialized your application as app inside api.py.

project
├── api.py
├── requirements.txt
└── serverless.yml

api.py

A regular Flask application.

from flask import Flask
app = Flask(__name__)


@app.route("/cats")
def cats():
    return "Cats"


@app.route("/dogs/<id>")
def dog(id):
    return "Dog"

serverless.yml

Load the plugin and set the custom.wsgi.app configuration in serverless.yml to the module path of your Flask application.

All functions that will use WSGI need to have wsgi.handler set as the Lambda handler and use the default lambda-proxy integration for API Gateway. This configuration example treats API Gateway as a transparent proxy, passing all requests directly to your Flask application, and letting the application handle errors, 404s etc.

service: example

provider:
  name: aws
  runtime: python2.7

plugins:
  - serverless-wsgi

functions:
  api:
    handler: wsgi.handler
    events:
      - http: ANY /
      - http: ANY {proxy+}

custom:
  wsgi:
    app: api.app

requirements.txt

Add Flask to the application bundle.

Flask==0.12.2

Deployment

Simply run the serverless deploy command as usual:

$ sls deploy
Serverless: Packaging Python WSGI handler...
Serverless: Packaging required Python packages...
Serverless: Packaging service...
Serverless: Removing old service versions...
Serverless: Uploading CloudFormation file to S3...
Serverless: Uploading service .zip file to S3...
Serverless: Updating Stack...
Serverless: Checking Stack update progress...
..........
Serverless: Stack update finished...

Other frameworks

Set custom.wsgi.app in serverless.yml according to your WSGI callable:

Usage

Automatic requirement packaging

You'll need to include any packages that your application uses in the bundle that's deployed to AWS Lambda. This plugin helps you out by doing this automatically, as long as you specify your required packages in a requirements.txt file in the root of your Serverless service path:

Flask==0.12.2
requests==2.18.3

For more information, see https://pip.readthedocs.io/en/1.1/requirements.html.

You can use the requirement packaging functionality of serverless-wsgi without the WSGI handler itself by including the plugin in your serverless.yml configuration, without specifying the custom.wsgi.app setting. This will omit the WSGI handler from the package, but include any requirements specified in requirements.txt.

If you don't want to use automatic requirement packaging you can set custom.wsgi.packRequirements to false:

custom:
  wsgi:
    app: api.app
    packRequirements: false

For a more advanced approach to packaging requirements, consider using https://github.com/UnitedIncome/serverless-python-requirements.

Python version

Python is used for packaging requirements and serving the app when invoking sls wsgi serve. By default, the current runtime setting is expected to be the name of the Python binary in PATH, for instance python3.6. If this is not the name of your Python binary, override it using the pythonBin option:

custom:
  wsgi:
    app: api.app
    pythonBin: python3

Local server

For convenience, a sls wsgi serve command is provided to run your WSGI application locally. This command requires the werkzeug Python package to be installed, and acts as a simple wrapper for starting werkzeug's built-in HTTP server.

By default, the server will start on port 5000.

$ sls wsgi serve
 * Running on http://localhost:5000/ (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!

Configure the port using the -p parameter:

$ sls wsgi serve -p 8000
 * Running on http://localhost:8000/ (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!

When running locally, an environment variable named IS_OFFLINE will be set to "True". So, if you want to know when the application is running locally, check os.environ["IS_OFFLINE"].

Explicit routes

If you'd like to be explicit about which routes and HTTP methods should pass through to your application, see the following example:

service: example

provider:
  name: aws
  runtime: python2.7

plugins:
  - serverless-wsgi

functions:
  api:
    handler: wsgi.handler
    events:
      - http:
          path: cats
          method: get
          integration: lambda-proxy
      - http:
          path: dogs/{id}
          method: get
          integration: lambda-proxy

custom:
  wsgi:
    app: api.app

Custom domain names

If you use custom domain names with API Gateway, you might have a base path that is at the beginning of your path, such as the stage (/dev, /stage, /prod). You can pass in an API_GATEWAY_BASE_PATH environment variable so your WSGI app can handle it correctly.

The example below uses the serverless-domain-manager plugin to handle custom domains in API Gateway:

service: example

provider:
  name: aws
  runtime: python2.7
  environment:
    API_GATEWAY_BASE_PATH: ${self:custom.customDomain.basePath}

plugins:
  - serverless-wsgi
  - serverless-domain-manager

functions:
  api:
    handler: wsgi.handler
    events:
      - http: ANY /
      - http: ANY {proxy+}

custom:
  wsgi:
    app: api.app
  customDomain:
    basePath: ${opt:stage}
    domainName: mydomain.name.com
    stage: ${opt:stage}
    createRoute53Record: true

File uploads

In order to accept file uploads from HTML forms, make sure to add multipart/form-data to the list of content types with Binary Support in your API Gateway API. The serverless-apigw-binary Serverless plugin can be used to automate this process.

Keep in mind that, when building Serverless applications, uploading directly to S3 from the browser is usually the preferred approach.

Raw context and event

The raw context and event from AWS Lambda are both accessible through the WSGI request. The following example shows how to access them when using Flask:

from flask import Flask, request
app = Flask(__name__)


@app.route("/")
def index():
    print(request.environ['context'])
    print(request.environ['event'])

Text MIME types

By default, all MIME types starting with text/ and the following whitelist are sent through API Gateway in plain text. All other MIME types will have their response body base64 encoded (and the isBase64Encoded API Gateway flag set) in order to be delivered by API Gateway as binary data.

This is the default whitelist of plain text MIME types:

  • application/json
  • application/javascript
  • application/xml
  • application/vnd.api+json

In order to add additional plain text MIME types to this whitelist, use the textMimeTypes configuration option:

custom:
  wsgi:
    app: api.app
    textMimeTypes:
    - application/custom+json
    - application/vnd.company+json

Usage without Serverless

The AWS API Gateway to WSGI mapping module is available on PyPI in the serverless-wsgi package.

Use this package if you need to deploy Python Lambda functions to handle API Gateway events directly, without using the Serverless framework.

pip install serverless-wsgi

Initialize your WSGI application and in your Lambda event handler, call the request mapper:

import app  # Replace with your actual application
import serverless_wsgi

# If you need to send additional content types as text, add then directly
# to the whitelist:
#
# serverless_wsgi.TEXT_MIME_TYPES.append("application/custom+json")

def handle(event, context):
    return serverless_wsgi.handle_request(app.app, event, context)

Thanks

Thanks to Zappa, which has been both the inspiration and source of several implementations that went into this project.

Thanks to chalice for the requirement packaging implementation.