AWSGI allows you to use WSGI-compatible middleware and frameworks like Flask and Django with the AWS API Gateway/Lambda proxy integration.
This is an improved fork of original aws-wsgi.
Installation
awsgi2 is available from PyPI as awsgi2:
pip install awsgi2
Examples
Flask
import awsgi2
from flask import (
Flask,
jsonify,
)
app = Flask(__name__)
@app.route('/')
def index():
return jsonify(status=200, message='OK')
def lambda_handler(event, context):
return awsgi2.response(app, event, context, base64_content_types={"image/png"})
Django
import os
import awsgi2
from django.core.wsgi import get_wsgi_application
# my_app_directory/settings.py is a vanilla Django settings file, created by "django-admin startproject".
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'my_app_directory.settings')
# In the settings.py file, you may find it useful to include this setting to remove
# Django's need for SQLite, which is currently (2020-11-17) outdated in the Lambda runtime image
# DATABASES = { 'default': { 'ENGINE': 'django.db.backends.dummy', } }
application = get_wsgi_application()
def lambda_handler(event, context):
return awsgi2.response(application, event, context, base64_content_types={"image/png"})
Docker
For more controlled deployments and to get rid of “works on my computer” -syndrome, we always make sure our software works under docker.
It’s also a quick way to get started with a standard development environment.
SSH agent forwarding
We need buildkit:
export DOCKER_BUILDKIT=1
And also the exact way for forwarding agent to running instance is different on OSX:
export DOCKER_SSHAGENT="-v /run/host-services/ssh-auth.sock:/run/host-services/ssh-auth.sock -e SSH_AUTH_SOCK=/run/host-services/ssh-auth.sock"
and Linux:
export DOCKER_SSHAGENT="-v $SSH_AUTH_SOCK:$SSH_AUTH_SOCK -e SSH_AUTH_SOCK"
Creating a development container
Build image, create container and start it:
docker build --ssh default --target devel_shell -t awsgi2:devel_shell . docker create --name awsgi2_devel -v `pwd`":/app" -it `echo $DOCKER_SSHAGENT` awsgi2:devel_shell docker start -i awsgi2_devel
pre-commit considerations
If working in Docker instead of native env you need to run the pre-commit checks in docker too:
docker exec -i awsgi2_devel /bin/bash -c "pre-commit install" docker exec -i awsgi2_devel /bin/bash -c "pre-commit run --all-files"
You need to have the container running, see above. Or alternatively use the docker run syntax but using the running container is faster:
docker run --rm -it -v `pwd`":/app" awsgi2:devel_shell -c "pre-commit run --all-files"
Test suite
You can use the devel shell to run py.test when doing development, for CI use the “tox” target in the Dockerfile:
docker build --ssh default --target tox -t awsgi2:tox . docker run --rm -it -v `pwd`":/app" `echo $DOCKER_SSHAGENT` awsgi2:tox
Development
TLDR:
Create and activate a Python 3.8 virtualenv (assuming virtualenvwrapper):
mkvirtualenv -p `which python3.8` my_virtualenv
change to a branch:
git checkout -b my_branch
install Poetry: https://python-poetry.org/docs/#installation
Install project deps and pre-commit hooks:
poetry install pre-commit install pre-commit run --all-files
Ready to go.
Remember to activate your virtualenv whenever working on the repo, this is needed because pylint and mypy pre-commit hooks use the “system” python for now (because reasons).
Metadata
Release files for awsgi2 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| awsgi2-1.0.2.tar.gz | 6.9 kB | Without provenance | Details for awsgi2-1.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| awsgi2-1.0.2-py3-none-any.whl | Python 3 | none | any | Details for awsgi2-1.0.2-py3-none-any.whl |
Total release size: 15.4 kB
Release files / awsgi2-1.0.2.tar.gz
| Download URL | awsgi2-1.0.2.tar.gz |
|---|---|
| Size | 6.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9463ebcc8ce7bd1b18373936eff8d33d6b791952509d6cb9b2e3e940aca54255
|
|
BLAKE2b-256 checksum How to use checksums |
128c6c185be230c7431c4994885b94d1ea1d3962aa2cd11068f69d159f0a2a45
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.11.11
|
Release files / awsgi2-1.0.2-py3-none-any.whl
| Download URL | awsgi2-1.0.2-py3-none-any.whl |
|---|---|
| Size | 8.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0ca33a362f79747419bb7227a69fdbc27cb25a7cc6c461efc857a47d5dbb693f
|
|
BLAKE2b-256 checksum How to use checksums |
bfd0fb5e8612a5dc0786bfd9e11badf832492599c4b0f314adde36319c399996
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.11.11
|
Security for awsgi2 1.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.