Skip to main content

Wrap a WSGI application in an AWS Lambda handler function for running on API Gateway or an ALB.

Project description

https://img.shields.io/travis/adamchainz/apig-wsgi/master.svg https://img.shields.io/pypi/v/apig-wsgi.svg

Wrap a WSGI application in an AWS Lambda handler function for running on API Gateway or an ALB.

A quick example:

from apig_wsgi import make_lambda_handler
from myapp.wsgi import app

# Configure this as your entry point in AWS Lambda
lambda_handler = make_lambda_handler(app)

Installation

Use pip:

pip install apig-wsgi

Tested on Python versions 2.7 and 3.7.

Usage

make_lambda_handler(app, binary_support=False)

app should be a WSGI app, for example from Django’s wsgi.py or Flask’s Flask() object.

If you want to support sending binary responses, set binary_support to True. ALB’s support binary responses by default, but on API Gateway you need to make sure you have '*/*' in the ‘binary media types’ configuration on your Rest API (whilst API Gateway supports a list of binary media types, using '*/*' is the best way to do it, since it is used to match the request ‘Accept’ header as well, which WSGI applications are likely to ignore).

Note that binary responses aren’t sent if your response has a ‘Content-Type’ starting ‘text/html’ or ‘application/json’ - this is to support sending larger text responses.

History

Pending Release

2.0.1 (2019-02-07)

  • Temporarily restore Python 2 support. This is in order to fix a packaging metadata issue that 2.0.0 was marked as supporting Python 2, so a new release is needed with a higher version number for pip install apig-wsgi to resolve properly on Python 2. Version 2.0.2+ of apig-wsgi will not support Python 2.

2.0.0 (2019-01-28)

  • Drop Python 2 support, only Python 3.4+ is supported now.

  • If exc_info is passed in, re-raise the exception (previously it would be ignored and crash in a different way). This isn’t the nicest experience, however the behaviour is copied from wsgiref's simple server, and most WSGI applications implement their own exception conversion to a “500 Internal Server Error” page already.

  • Noted that the EC2 ALB to Lambda integration is also supported as it uses the same event format as API Gateway.

1.2.0 (2018-05-14)

  • Work with base64 encoded body values in requests from API Gateway.

1.1.2 (2018-05-11)

  • Fix crash using binary support for responses missing a Content-Type header.

1.1.1 (2018-05-11)

  • Remove debug print()

1.1.0 (2018-05-10)

  • Add binary_support flag to enable sending binary responses, if enabled on API Gateway.

1.0.0 (2018-03-08)

  • First release on PyPI, working basic integration for WSGI apps on API Gateway.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apig-wsgi-2.0.1.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

apig_wsgi-2.0.1-py2.py3-none-any.whl (4.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file apig-wsgi-2.0.1.tar.gz.

File metadata

  • Download URL: apig-wsgi-2.0.1.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/2.7.15

File hashes

Hashes for apig-wsgi-2.0.1.tar.gz
Algorithm Hash digest
SHA256 a28df014140b59f3976853c5e0ae4d10a3d34a84b3b701541c0dc6eb0da8c7cd
MD5 547d9e01849f1375e030db3bad99274a
BLAKE2b-256 25b9aab0a91f58ca07498a37ca8ec1753ecef4f05cfa3444a1da884077d6611f

See more details on using hashes here.

File details

Details for the file apig_wsgi-2.0.1-py2.py3-none-any.whl.

File metadata

  • Download URL: apig_wsgi-2.0.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/2.7.15

File hashes

Hashes for apig_wsgi-2.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 12347dc42e4065ec31f4f14d41072d187e39105e19b269a9c22d96247081f231
MD5 be9674b24d64d1cc2a06fee631b32b34
BLAKE2b-256 1351a6fd2c060b00e5099218a1c47bba97fa060b3ce4b8f30069ed1a7e0f2c53

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page