Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

Serverless WSGI With AWS Lambda + API Gateway

Project description

.. raw:: html

<p align="center">

.. raw:: html

</p>

Zappa - Serverless Python Web Services
======================================

|Build Status| |Coverage| |Slack|

**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.

It's great for deploying serverless microservices with frameworks like
Flask and Bottle, and for hosting larger web apps and CMSes with Django.
Or, you can use any WSGI-compatible app you like!

Using **Zappa** 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 and utility, which can be
used by any WSGI-compatible web framework (which is pretty much all of
them.) Zappa 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

Installation and Configuration
==============================

*Before you begin, make sure you have a valid AWS account and your `AWS
credentials
file <https://blogs.aws.amazon.com/security/post/Tx3D6U6WSFGOK2H/A-New-and-Standardized-Way-to-Manage-Credentials-in-the-AWS-SDKs>`__
is properly installed.*

**Zappa** can easily be installed through pip, like so:

::

$ pip install zappa

If you're looking for Django-specific integration, you should probably
check out
***`django-zappa <https://github.com/Miserlou/django-zappa>`__***
instead.

Next, you'll need to define your local and server-side settings.

Local Settings
--------------

First, you'll need to define a few local settings for your Zappa
deployment environments in a file named *zappa\_settings.json* in your
project directory. The simplest example is:

.. code:: javascript

{
"prod": { // The name of your environment
"s3_bucket": "lmbda", // The name of your S3 Bucket
"settings_file": "prod_settings.py" // Path to your remote settings file
}
}

You can define as many environments as your like - we recommend having a
*dev*, *staging*, and *production*.

Remote Settings
---------------

Next, you'll need to define the settings for remote environment in the
*settings\_file*. The simplest example of this is:

.. code:: python

APP_MODULE = 'your_module' # The path to the module
APP_FUNCTION = 'app' # The WSGI function (or a function that returns it)

If you have a Flask application, this will likely point to your Flask
'app', but you can point this to any WSGI function.

Now, you're ready to deploy!

Basic Usage
===========

Initial Deployments
-------------------

Once your settings are configured, you can package and deploy your
application to an environment called "production" with a single command:

::

$ zappa deploy production
Deploying..
Your application is now live at: https://7k6anj0k99.execute-api.us-east-1.amazonaws.com/production

And now your app is **live!** How cool is that?!

To expain what's going on, when you call 'deploy', Zappa will
automatically package up your application and local virtual environment
into a Lambda-compatible archive, replace any dependencies with versions
`precompiled for
Lambda <https://github.com/Miserlou/lambda-packages>`__, set up the
function handler and necessary WSGI Middleware, upload the archive to
S3, register it as a new Lambda function, create a new API Gateway
resource, create WSGI-compatible routes for it, link it to the new
Lambda function, and finally delete the archive from your S3 bucket.
Handy!

Updates
-------

If your application has already been deployed and you only need to
upload new Python code, but not touch the underlying routes, you can
simply:

::

$ zappa update production
Updating..
Your application is now live at: https://7k6anj0k99.execute-api.us-east-1.amazonaws.com/production

This creates a new archive, uploads it to S3 and updates the Lambda
function to use the new code, but doesn't touch the API Gateway routes.

Rollback
--------

You can also rollback the deployed code to a previous version by
supplying the number of revisions to return to. For instance, to
rollback to the version deployed 3 versions ago:

::

$ zappa rollback production -n 3

Tailing Logs
------------

You can watch the logs of a deployment by calling the "tail" management
command.

::

$ zappa tail production

Advanced Usage
==============

There are other settings that you can define in your local settings to
change Zappa's behavior. Use these at your own risk!

.. code:: javascript

{
"dev": {
"aws_region": "us-east-1", // AWS Region (default US East),
"domain": "yourapp.yourdomain.com", // Required if you're using a domain
"http_methods": ["GET", "POST"], // HTTP Methods to route,
"integration_response_codes": [200, 301, 404, 500], // Integration response status codes to route
"memory_size": 512, // Lambda function memory in MB
"method_response_codes": [200, 301, 404, 500], // Method response status codes to route
"parameter_depth": 10, // Size of URL depth to route. Defaults to 5.
"role_name": "MyLambdaRole", // Lambda execution Role
"s3_bucket": "dev-bucket", // Zappa zip bucket,
"settings_file": "~/Projects/MyApp/settings/dev_settings.py", // Server side settings file location,
"touch": false, // GET the production URL upon initial deployment (default True)
"use_precompiled_packages": false, // If possible, use C-extension packages which have been pre-compiled for AWS Lambda
"vpc_config": { // Optional VPC configuration for Lambda function
"SubnetIds": [ "subnet-12345678" ], // Note: not all availability zones support Lambda!
"SecurityGroupIds": [ "sg-12345678" ]
}
}
}

Keeping the server warm
-----------------------

Lambda has a limitation that functions which aren't called very often
take longer to start - sometimes up to ten seconds. However, functions
that are called regularly are cached and start quickly, usually in less
than 50ms. To ensure that your servers are kept in a cached state, you
can `manually configure <http://stackoverflow.com/a/27382253>`__ a
scheduled task for your Zappa function that'll keep the server cached by
calling it every 5 minutes. There is currently no way to configure this
through API, so you'll have to set this up manually. When this ability
is available via API, Zappa will configure this automatically. It would
be nice to also add support LetsEncrypt through this same mechanism.

Enabling CORS
-------------

To enable Cross-Origin Resource Sharing (CORS) for your application,
follow the `AWS "How to CORS"
Guide <https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-cors.html>`__
to enable CORS via the API Gateway Console. Don't forget to re-deploy
your API after making the changes!

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 <https://zappa.gun.io>`__ - A Zappa "Hello, World"
(real homepage coming.. soon..)
- `spheres.gun.io <https://spheres.gun.io>`__ - Spheres, a photosphere
host and viewer
- `Mailchimp Signup
Utility <https://github.com/sasha42/Mailchimp-utility>`__ - A
microservice for adding people to a mailing list via API.
- 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
- Feedback
- Real documentation / website!

.. |Build Status| image:: https://travis-ci.org/Miserlou/Zappa.svg
:target: https://travis-ci.org/Miserlou/Zappa
.. |Coverage| image:: https://img.shields.io/coveralls/Miserlou/Zappa.svg
:target: https://coveralls.io/github/Miserlou/Zappa
.. |Slack| image:: https://img.shields.io/badge/chat-slack-ff69b4.svg
:target: https://slackautoinviter.herokuapp.com/

Project details


Release history Release notifications

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
zappa-0.14.1-py2-none-any.whl (29.6 kB) Copy SHA256 hash SHA256 Wheel 2.7
zappa-0.14.1.tar.gz (25.3 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page