Skip to main content
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

Python 3.4+ supported.

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.1.1 (2019-03-31)

  • Revert adding statusDescription because it turns out API Gateway doesn’t ignore it but instead fails the response with an internal server error.

2.1.0 (2019-03-31)

  • Change statusCode returned to API Gateway / ALB to an integer. It seems API Gateway always supported both strings and integers, whilst API Gateway only supports integers.

  • Add statusDescription in return value. API Gateway doesn’t seem to use this whilst the ALB documentation mentions it as supported.

2.0.2 (2019-02-07)

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

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.

Metadata

Release files for apig-wsgi 2.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for apig-wsgi 2.1.1
File Size Uploaded
apig-wsgi-2.1.1.tar.gz 5.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for apig-wsgi 2.1.1
File Interpreter ABI Platform
apig_wsgi-2.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 10.5 kB

Release files / apig-wsgi-2.1.1.tar.gz

Download URL apig-wsgi-2.1.1.tar.gz
Size 5.4 kB
Tags Source
SHA-256 checksum
How to use checksums
f60e8c119ffc225047bb61af66ff3f85f5b7f962c7b291d0bad954f0a5d73ffa
BLAKE2b-256 checksum
How to use checksums
5de43d683105d944170aa3e1d03fbffec154772de26f115bbb64d4c5828a641d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.7.3

Release files / apig_wsgi-2.1.1-py3-none-any.whl

Download URL apig_wsgi-2.1.1-py3-none-any.whl
Size 5.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
07ec932e9a2e951f3ad8802f7578639509038aa4db6587eff879cfc363606d99
BLAKE2b-256 checksum
How to use checksums
0ceb18cb2c939b1748454e6288b8d98d1f00411aa54201f393e5a8876893aca4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.7.3

Release history Release notifications | RSS feed

2.17.0

2 release files

2.16.0

2 release files

2.15.0

2 release files

2.14.0

2 release files

2.13.0

2 release files

2.12.1

2 release files

2.12.0

2 release files

2.11.0

2 release files

2.10.0

2 release files

2.9.2

2 release files

2.9.1

2 release files

2.9.0

2 release files

2.8.0

2 release files

2.7.0

2 release files

2.6.0

2 release files

2.5.1

2 release files

2.5.0

2 release files

2.4.1

2 release files

2.4.0

2 release files

2.3.0

2 release files

2.2.0

2 release files

This release

2.1.1 This release

2 release files

2.1.0

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.2.0

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page