Skip to main content

Serverless WSGI With AWS Lambda + API Gateway

Project description

Logo placeholder # Zappa Build Status Coverage Slack #### Serverless WSGI with AWS Lambda + API Gateway

Zappa makes it super easy to deploy all Python WSGI applications on AWS Lambda + API Gateway. Think of it as “serverless” web hosting for your Python web apps.

That means:

  • No more tedious web server configuration!

  • No more paying for 24/7 server uptime!

  • No more worrying about load balancing / scalability!

  • No more worrying about keeping servers online!

Awesome!

This project is for the Zappa core library, which can be used by any WSGI-compatible web framework (which is pretty much all of them.) This library also handles:

  • Packaging projects into Lambda-ready zip files and uploading them to S3

  • Correctly setting up IAM roles and permissions

  • Automatically configuring API Gateway routes, methods and integration responses

  • Deploying the API to various stages of readiness

If you are looking for the version for your favorite web frameworks, you should probably try here:

  • `django-zappa <https://github.com/Miserlou/django-zappa>`__

  • `flask-zappa <https://github.com/Miserlou/flask-zappa>`__

  • pyramid-zappa (Coming.. maybe?)

Usage

If you just want to use Zappa to deploy your web application, you’ll probably want to use a client library like django-zappa instead. But, if you want to create a new client library or use Zappa directly, you can follow the steps below.

You can install Zappa through pip:

$ pip install zappa

Then, you’ll want to call its main capabilities in order:

# Set your configuration
project_name = "MyProject"
api_stage = "Production"
s3_bucket_name = 'MyLambdaBucket'

# Make your Zappa object
zappa = Zappa()

# Load your AWS credentials from ~/.aws/credentials
zappa.load_credentials()

# Make sure the necessary IAM execution roles are available
zappa.create_iam_roles()

# Create the Lambda zip package (includes project and virtualenvironment)
zip_path = zappa.create_lambda_zip(project_name)

# Upload it to S3
zip_arn = zappa.upload_to_s3(zip_path, s3_bucket_name)

# Register the Lambda function with that zip as the source
# You'll also need to define the path to your lambda_handler code.
lambda_arn = zappa.create_lambda_function(s3_bucket_name, zip_path, project_name, 'runme.lambda_handler')

# Create and configure the API Gateway
api_id = zappa.create_api_gateway_routes(lambda_arn)

# Deploy the API!
endpoint_url = zappa.deploy_api_gateway(api_id, api_stage)

print("Your Zappa deployment is live!: " + endpoint_url)

And your application is live!

Hacks

Zappa goes quite far beyond what Lambda and API Gateway were ever intended to handle. As a result, there are quite a few hacks in here that allow it to work. Some of those include, but aren’t limited to..

  • Using VTL to map body, headers, method, params and query strings into JSON, and then turning that into valid WSGI.

  • Attaching response codes to response bodies, Base64 encoding the whole thing, using that as a regex to route the response code, decoding the body in VTL, and mapping the response body to that.

  • Packing and Base58 encoding multiple cookies into a single cookie because we can only map one kind.

  • Turning cookie-setting 301/302 responses into 200 responses with HTML redirects, because we have no way to set headers on redirects.

Sites Using Zappa

  • zappa.gun.io - A Zappa “Hello, World” (real homepage coming.. soon..)

  • spheres.gun.io - Spheres, a photosphere host and viewer

  • Your site here?

TODO

This project is very young, so there is still plenty to be done. Contributions are more than welcome! Please file tickets before submitting patches, and submit your patches to the ‘dev’ branch.

Things that need work right now:

  • Testing

  • Clients for frameworks besides Django

  • Feedback

  • Real documentation / website!

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

zappa-0.13.0.tar.gz (16.7 kB view details)

Uploaded Source

Built Distribution

zappa-0.13.0-py2-none-any.whl (19.8 kB view details)

Uploaded Python 2

File details

Details for the file zappa-0.13.0.tar.gz.

File metadata

  • Download URL: zappa-0.13.0.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for zappa-0.13.0.tar.gz
Algorithm Hash digest
SHA256 a5d5fd078ae3b5dc0e93e897fd5902827fa8239a7ff57d7cdf6b88d16dcf399b
MD5 aee4537491b941b34585c5c8778b39b5
BLAKE2b-256 75b62b22fe50806d429a3673b33c98b9c395fff84c2cdfdeeb0587f4ec989629

See more details on using hashes here.

Provenance

File details

Details for the file zappa-0.13.0-py2-none-any.whl.

File metadata

File hashes

Hashes for zappa-0.13.0-py2-none-any.whl
Algorithm Hash digest
SHA256 1796bd8731dd1795900003b15a270769cd0fe2ead97f72cd2fcc163de697b57d
MD5 d9fbcfb1b34162c57187a666e0bc7a08
BLAKE2b-256 309351368985d3f338859fadaa993b840372128046ceca294a401339da4fcbf1

See more details on using hashes here.

Provenance

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