zappa 0.36.1

.. raw:: html

<p align="center">

.. raw:: html

</p>

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

|Build Status| |Coverage| |Requirements Status| |PyPI| |Slack| |Gun.io|

.. raw:: html

<!-- START doctoc generated TOC please keep comment here to allow auto update -->

.. raw:: html

<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- `About <#about>`__
- `Installation and Configuration <#installation-and-configuration>`__

- `Running the Initial Setup /
Settings <#running-the-initial-setup--settings>`__

- `Basic Usage <#basic-usage>`__

- `Initial Deployments <#initial-deployments>`__
- `Updates <#updates>`__
- `Rollback <#rollback>`__
- `Scheduling <#scheduling>`__
- `Executing in Response to AWS
Events <#executing-in-response-to-aws-events>`__
- `Undeploy <#undeploy>`__
- `Package <#package>`__
- `Status <#status>`__
- `Tailing Logs <#tailing-logs>`__
- `Remote Function Invocation <#remote-function-invocation>`__
- `Django Management Commands <#django-management-commands>`__
- `Let's Encrypt SSL Domain Certification and
Installation <#lets-encrypt-ssl-domain-certification-and-installation>`__

- `Advanced Settings <#advanced-settings>`__

- `YAML Settings <#yaml-settings>`__

- `Advanced Usage <#advanced-usage>`__

- `Keeping The Server Warm <#keeping-the-server-warm>`__
- `Serving Static Files / Binary
Uploads <#serving-static-files--binary-uploads>`__
- `Enabling CORS <#enabling-cors>`__
- `Enabling Bash Completion <#enabling-bash-completion>`__
- `Enabling Secure Endpoints on API
Gateway <#enabling-secure-endpoints-on-api-gateway>`__
- `API Key <#api-key>`__
- `IAM Policy <#iam-policy>`__
- `API Gateway Authorizers <#api-gateway-authorizers>`__
- `Cognito User Pool Authorizer <#cognito-user-pool-authorizer>`__
- `Deploying to a Custom Domain Name with SSL
Certificates <#deploying-to-a-custom-domain-name-with-ssl-certificates>`__
- `Deploying to a Domain With a Let's Encrypt Certificate (DNS
Auth) <#deploying-to-a-domain-with-a-lets-encrypt-certificate-dns-auth>`__
- `Deploying to a Domain With a Let's Encrypt Certificate (HTTP
Auth) <#deploying-to-a-domain-with-a-lets-encrypt-certificate-http-auth>`__
- `Deploying with Custom Domain Name (with your own SSL
Certs) <#deploying-with-custom-domain-name-with-your-own-ssl-certs>`__
- `Setting Environment Variables <#setting-environment-variables>`__
- `Local Environment Variables <#local-environment-variables>`__
- `Remote Environment Variables <#remote-environment-variables>`__
- `Catching Unhandled Exceptions <#catching-unhandled-exceptions>`__
- `Using Custom AWS IAM Roles and
Policies <#using-custom-aws-iam-roles-and-policies>`__
- `Globally Available Server-less
Architectures <#globally-available-server-less-architectures>`__
- `Raising AWS Service Limits <#raising-aws-service-limits>`__

- `Zappa Guides <#zappa-guides>`__
- `Zappa in the Press <#zappa-in-the-press>`__
- `Sites Using Zappa <#sites-using-zappa>`__
- `Related Projects <#related-projects>`__
- `Hacks <#hacks>`__
- `Contributing <#contributing>`__

- `Using a Local Repo <#using-a-local-repo>`__

- `Support / Development / Training /
Consulting <#support--development--training--consulting>`__

.. raw:: html

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

About
=====

.. raw:: html

<p align="center">

.. raw:: html

</p>

.. raw:: html

<p align="center">

In a hurry? Click to see slides from Serverless SF!

.. raw:: html

</p>

**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 **infinite scaling**, **zero
downtime**, **zero maintenance** - and at a fraction of the cost of your
current deployments!

If you've got a Python web app (including Django and Flask apps), it's
as easy as:

::

$ pip install zappa
$ zappa init
$ zappa deploy

and now you're server-less! *Wow!*

What do you mean "serverless"?

Okay, so there still is a server - but it only has a *40 millisecond*
life cycle! Serverless in this case means **"without any permanent
infrastructure."**

With a traditional HTTP server, the server is online 24/7, processing
requests one by one as they come in. If the queue of incoming requests
grows too large, some requests will time out. With Zappa, **each request
is given its own virtual HTTP "server"** by Amazon API Gateway. AWS
handles the horizontal scaling automatically, so no requests ever time
out. Each request then calls your application from a memory cache in AWS
Lambda and returns the response via Python's WSGI interface. After your
app returns, the "server" dies.

Better still, with Zappa you only pay for the milliseconds of server
time that you use, so it's many **orders of magnitude cheaper** than
VPS/PaaS hosts like Linode or Heroku - and in most cases, it's
completely free. Plus, there's no need to worry about load balancing or
keeping servers online ever again.

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! You **probably don't
need to change your existing applications** to use it, and you're not
locked into using it.

And finally, Zappa is **super easy to use**. You can deploy your
application with a single command out of the box.

**Awesome!**

.. raw:: html

<p align="center">

.. raw:: html

</p>

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

Please note that Zappa ***must*** be installed into your project's
`virtual
environment <http://docs.python-guide.org/en/latest/dev/virtualenvs/>`__.

*(If you use `pyenv <https://github.com/yyuu/pyenv>`__ and love to
manage virtualenvs with **pyenv-virtualenv**, you just have to call
``pyenv local [your_venv_name]`` and it's ready.
`Conda <http://conda.pydata.org/docs/>`__ users should comment
`here <https://github.com/Miserlou/Zappa/pull/108>`__.)*

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

Running the Initial Setup / Settings
------------------------------------

**Zappa** can automatically set up your deployment settings for you with
the ``init`` command:

::

$ zappa init

This will automatically detect your application type (Flask/Django -
Pyramid users `see
here <https://github.com/Miserlou/Zappa/issues/278#issuecomment-241917956>`__)
and help you define your deployment configuration settings. Once you
finish initialization, you'll have a file named *zappa\_settings.json*
in your project directory defining your basic deployment settings. It
will probably look something like this for most WSGI apps:

.. code:: javascript

{
// The name of your stage
"dev": {
// The name of your S3 bucket
"s3_bucket": "lmbda",

// The modular python path to your WSGI application function.
// In Flask and Bottle, this is your 'app' object.
// Flask (your_module.py):
// app = Flask()
// Bottle (your_module.py):
// app = bottle.default_app()
"app_function": "your_module.app"
}
}

or for Django:

.. code:: javascript

{
"dev": { // The name of your stage
"s3_bucket": "lmbda", // The name of your S3 bucket
"django_settings": "your_project.settings" // The python path to your Django settings.
}
}

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

Now, you're ready to deploy!

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

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

Once your settings are configured, you can package and deploy your
application to a stage 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 explain 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

Scheduling
----------

Zappa can be used to easily schedule functions to occur on regular
intervals. This provides a much nicer, maintenance-free alternative to
Celery! These functions will be packaged and deployed along with your
``app_function`` and called from the handler automatically. Just list
your functions and the expression to schedule them using `cron or rate
syntax <http://docs.aws.amazon.com/lambda/latest/dg/tutorial-scheduled-events-schedule-expressions.html>`__
in your *zappa\_settings.json* file:

.. code:: javascript

{
"production": {
...
"events": [{
"function": "your_module.your_function", // The function to execute
"expression": "rate(1 minute)" // When to execute it (in cron or rate format)
}],
...
}
}

And then:

::

$ zappa schedule production

And now your function will execute every minute!

If you want to cancel these, you can simply use the ``unschedule``
command:

::

$ zappa unschedule production

And now your scheduled event rules are deleted.

See the `example <example/>`__ for more details.

Executing in Response to AWS Events
-----------------------------------

Similarly, you can have your functions execute in response to events
that happen in the AWS ecosystem, such as S3 uploads, DynamoDB entries,
Kinesis streams, and SNS messages.

In your *zappa\_settings.json* file, define your `event
sources <http://docs.aws.amazon.com/lambda/latest/dg/invoking-lambda-function.html>`__
and the function you wish to execute. For instance, this will execute
``your_module.your_function`` in response to new objects in your
``my-bucket`` S3 bucket. Note that ``your_function`` must accept
``event`` and ``context`` parameters.

.. code:: javascript

{
"production": {
...
"events": [{
"function": "your_module.your_function",
"event_source": {
"arn": "arn:aws:s3:::my-bucket",
"events": [
"s3:ObjectCreated:*" // Supported event types: http://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#supported-notification-event-types
]
}
}],
...
}
}

And then:

::

$ zappa schedule production

And now your function will execute every time a new upload appears in
your bucket!

Similarly, for a `Simple Notification
Service <https://aws.amazon.com/sns/>`__ event:

.. code:: javascript

"events": [
{
"function": "your_module.your_function",
"event_source": {
"arn": "arn:aws:sns:::your-event-topic-arn",
"events": [
"sns:Publish"
]
}
}
]

`DynamoDB <http://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html>`__
and
`Kinesis <http://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html>`__
are slightly different as it is not event based but pulling from a
stream:

.. code:: javascript

"events": [
{
"function": "replication.replicate_records",
"event_source": {
"arn": "arn:aws:dynamodb:us-east-1:1234554:table/YourTable/stream/2016-05-11T00:00:00.000",
"starting_position": "TRIM_HORIZON", // Supported values: TRIM_HORIZON, LATEST
"batch_size": 50, // Max: 1000
"enabled": true // Default is false
}
}
]

You can find more `example event sources
here <http://docs.aws.amazon.com/lambda/latest/dg/eventsources.html>`__.

Undeploy
--------

If you need to remove the API Gateway and Lambda function that you have
previously published, you can simply:

::

$ zappa undeploy production

You will be asked for confirmation before it executes.

If you enabled CloudWatch Logs for your API Gateway service and you
don't want to keep those logs, you can specify the ``--remove-logs``
argument to purge the logs for your API Gateway and your Lambda
function:

::

$ zappa undeploy production --remove-logs

Package
-------

If you want to build your application package without actually uploading
and registering it as a Lambda function, you can use the ``package``
command:

::

$ zappa package production

If you have a ``zip`` callback in your ``callbacks`` setting, this will
also be invoked.

.. code:: javascript

{
"production": { // The name of your stage
"callbacks": {
"zip": "my_app.zip_callback"// After creating the package
}
}
}

Status
------

If you need to see the status of your deployment and event schedules,
simply use the ``status`` command.

::

$ zappa status production

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

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

::

$ zappa tail production

By default, this will show all log items. In addition to HTTP and other
events, anything ``print``\ ed to ``stdout`` or ``stderr`` will be shown
in the logs.

You can use the argument ``--http`` to filter for HTTP requests, which
will be in the Apache Common Log Format.

::

$ zappa tail production --http

Similarly, you can do the inverse and only show non-HTTP events and log
messages:

::

$ zappa tail production --non-http

If you don't like the default log colors, you can turn them off with
``--no-color``.

You can also limit the length of the tail with ``--since``, which
accepts a simple duration string:

::

$ zappa tail production --since 4h # 4 hours
$ zappa tail production --since 1m # 1 minute
$ zappa tail production --since 1mm # 1 month

You can filter out the contents of the logs with ``--filter``, like so:

::

$ zappa tail production --http --filter "POST" # Only show POST HTTP requests

Note that this uses the `CloudWatch Logs filter
syntax <http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html>`__.

Remote Function Invocation
--------------------------

You can execute any function in your application directly at any time by
using the ``invoke`` command.

For instance, suppose you have a basic application in a file called
"my\_app.py", and you want to invoke a function in it called
"my\_function". Once your application is deployed, you can invoke that
function at any time by calling:

::

$ zappa invoke production 'my_app.my_function'

Any remote print statements made and the value the function returned
will then be printed to your local console. **Nifty!**

You can also invoke interpretable Python 2.7 strings directly by using
``--raw``, like so:

::

$ zappa invoke production "print 1 + 2 + 3" --raw

Django Management Commands
--------------------------

As a convenience, Zappa can also invoke remote Django 'manage.py'
commands with the ``manage`` command. For instance, to perform the basic
Django status check:

::

$ zappa manage production showmigrations admin

Obviously, this only works for Django projects which have their settings
properly defined.

For commands which have their own arguments, you can also pass the
command in as a string, like so:

::

$ zappa manage production "shell --version"

Commands which require direct user input, such as ``createsuperuser``,
should be `replaced by commands <http://stackoverflow.com/a/26091252>`__
which use ``zappa <env> invoke --raw``.

*(Please note that commands which take over 30 seconds to execute may
time-out. See `this related
issue <https://github.com/Miserlou/Zappa/issues/205#issuecomment-236391248>`__
for a work-around.)*

Let's Encrypt SSL Domain Certification and Installation
-------------------------------------------------------

If you want to use Zappa applications on a custom domain or subdomain,
you'll need to supply a valid SSL certificate. Fortunately for you,
Zappa can automatically create and install free valid SSL certificates
using Let's Encrypt!

If your domain is located within an AWS Route 53 Hosted Zone and you've
defined ``domain`` and ``lets_encrypt_key`` (ex:
``openssl genrsa 2048 > account.key``) settings, all you need to do is:

::

$ zappa certify production

And your domain will be verified, certified and registered!

*(Please note that this can take around 45 minutes to take effect the
first time your run the command, and around 60 seconds every time after
that.)*

More detailed instructions are available `in this handy
guide <https://github.com/Miserlou/Zappa/blob/master/docs/domain_with_free_ssl_dns.md>`__.

Advanced Settings
=================

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": {
"api_key_required": false, // enable securing API Gateway endpoints with x-api-key header (default False)
"api_key": "your_api_key_id", // optional, use an existing API key. The option "api_key_required" must be true to apply
"apigateway_enabled": true, // Set to false if you don't want to create an API Gateway resource. Default true.
"assume_policy": "my_assume_policy.json", // optional, IAM assume policy JSON file
"attach_policy": "my_attach_policy.json", // optional, IAM attach policy JSON file
"aws_region": "aws-region-name", // optional, uses region set in profile or environment variables if not set here,
"binary_support": true, // Enable automatic MIME-type based response encoding through API Gateway. Default true.
"callbacks": { // Call custom functions during the local Zappa deployment/update process
"settings": "my_app.settings_callback", // After loading the settings
"zip": "my_app.zip_callback", // After creating the package
"post": "my_app.post_callback", // After command has executed
},
"cache_cluster_enabled": false, // Use APIGW cache cluster (default False)
"cache_cluster_size": 0.5, // APIGW Cache Cluster size (default 0.5)
"cloudwatch_log_level": "OFF", // Enables/configures a level of logging for the given staging. Available options: "OFF", "INFO", "ERROR", default "OFF".
"cloudwatch_data_trace": false, // Logs all data about received events.
"cloudwatch_metrics_enabled": false, // Additional metrics for the API Gateway.
"cors": true, // Enable Cross-Origin Resource Sharing. Default false. If true, simulates the "Enable CORS" button on the API Gateway console. Can also be a dictionary specifying lists of "allowed_headers", "allowed_methods", and string of "allowed_origin"
"debug": true, // Print Zappa configuration errors tracebacks in the 500
"delete_local_zip": true, // Delete the local zip archive after code updates
"delete_s3_zip": true, // Delete the s3 zip archive
"django_settings": "your_project.production_settings", // The modular path to your Django project's settings. For Django projects only.
"domain": "yourapp.yourdomain.com", // Required if you're using a domain
"environment_variables": {"your_key": "your_value"}, // A dictionary of environment variables that will be available to your deployed app. See also "remote_env". Default {}.
"events": [
{ // Recurring events
"function": "your_module.your_recurring_function", // The function to execute
"expression": "rate(1 minute)" // When to execute it (in cron or rate format)
},
{ // AWS Reactive events
"function": "your_module.your_reactive_function", // The function to execute
"event_source": {
"arn": "arn:aws:s3:::my-bucket", // The ARN of this event source
"events": [
"s3:ObjectCreated:*" // The specific event to execute in response to.
]
}
}
],
"exception_handler": "your_module.report_exception", // function that will be invoked in case Zappa sees an unhandled exception raised from your code
"exclude": ["*.gz", "*.rar"], // A list of regex patterns to exclude from the archive. To exclude boto3 and botocore (available in an older version on Lambda), add "boto3*" and "botocore*".
"extends": "stage_name", // Duplicate and extend another stage's settings. For example, `dev-asia` could extend from `dev-common` with a different `s3_bucket` value.
"iam_authorization": true, // optional, use IAM to require request signing. Default false. Note that enabling this will override the authorizer configuration.
"authorizer": {
"function": "your_module.your_auth_function", // Local function to run for token validation. For more information about the function see below.
"arn": "arn:aws:lambda:<region>:<account_id>:function:<function_name>", // Existing Lambda function to run for token validation.
"result_ttl": 300, // Optional. Default 300. The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches authorizer results. Currently, the maximum TTL value is 3600 seconds.
"token_source": "Authorization", // Optional. Default 'Authorization'. The name of a custom authorization header containing the token that clients submit as part of their requests.
"validation_expression": "^Bearer \\w+$", // Optional. A validation expression for the incoming token, specify a regular expression.
},
"keep_warm": true, // Create CloudWatch events to keep the server warm.
"keep_warm_expression": "rate(4 minutes)", // How often to execute the keep-warm, in cron and rate format. Default 4 minutes.
"lambda_description": "Your Description", // However you want to describe your project for the AWS console. Default "Zappa Deployment".
"lambda_handler": "your_custom_handler", // The name of Lambda handler. Default: handler.lambda_handler
"lets_encrypt_key": "s3://your-bucket/account.key", // Let's Encrypt account key path. Can either be an S3 path or a local file path.
"lets_encrypt_expression": "rate(15 days)" // How often to auto-renew Let's Encrypt certificate on the server. Must be set to enable autorenewing, rate or cron syntax.
"log_level": "DEBUG", // Set the Zappa log level. Can be one of CRITICAL, ERROR, WARNING, INFO and DEBUG. Default: DEBUG
"manage_roles": true, // Have Zappa automatically create and define IAM execution roles and policies. Default true. If false, you must define your own IAM Role and role_name setting.
"memory_size": 512, // Lambda function memory in MB
"prebuild_script": "your_module.your_function", // Function to execute before uploading code
"profile_name": "your-profile-name", // AWS profile credentials to use. Default 'default'.
"project_name": "MyProject", // The name of the project as it appears on AWS. Defaults to a slugified `pwd`.
"remote_env": "s3://my-project-config-files/filename.json", // optional file in s3 bucket containing a flat json object which will be used to set custom environment variables.
"role_name": "MyLambdaRole", // Name of Zappa execution role. Default ZappaExecutionRole. To use a different, pre-existing policy, you must also set manage_roles to false.
"s3_bucket": "dev-bucket", // Zappa zip bucket,
"slim_handler": false, // Useful if project >50M. Set true to just upload a small handler to Lambda and load actual project from S3 at runtime.
"settings_file": "~/Projects/MyApp/settings/dev_settings.py", // Server side settings file location,
"timeout_seconds": 30, // Maximum lifespan for the Lambda function (default 30, max 300.)
"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" ]
}
}
}

YAML Settings
-------------

If you prefer YAML over JSON, you can also use a ``zappa_settings.yml``,
like so:

.. code:: yaml

---
dev:
app_function: your_module.your_app
s3_bucket: your-code-bucket
events:
- function: your_module.your_function
event_source:
arn: arn:aws:s3:::your-event-bucket
events:
- s3:ObjectCreated:*

You can also supply a custom settings file at any time with the ``-s``
argument, ex:

::

$ zappa deploy dev -s my-custom-settings.yml

Similarly, you can supply a ``zappa_settings.toml`` file:

.. code:: toml

[dev]
app_function = "your_module.your_app"
s3_bucket = "your-code-bucket"

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

Keeping The Server Warm
-----------------------

Zappa will automatically set up a regularly occurring execution of your
application in order to keep the Lambda function warm. This can be
disabled via the 'keep\_warm' setting.

Serving Static Files / Binary Uploads
-------------------------------------

Zappa is now able to serve binary files, as detected by their MIME-type.

However, generally Zappa is designed for running your application code,
not for serving static web assets. If you plan on serving custom static
assets in your web application (CSS/JavaScript/images/etc.,), you'll
likely want to use a combination of AWS S3 and AWS CloudFront.

Your web application framework will likely be able to handle this for
you automatically. For Flask, there is
`Flask-S3 <https://github.com/e-dard/flask-s3>`__, and for Django, there
is
`Django-Storages <https://django-storages.readthedocs.io/en/latest/>`__.

Similarly, you will not be able to accept binary multi-part uploads
through the API Gateway. Instead, you should design your application so
that binary uploads go `directly to
S3 <http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/browser-examples.html#Uploading_a_local_file_using_the_File_API>`__,
which then triggers an event response defined in your ``events``
setting! That's thinking serverlessly!

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

The easiest way to enable CORS (Cross-Origin Resource Sharing) for in
your Zappa application is to set ``cors`` to ``true`` in your Zappa
settings file and updating, which is the equivalent of pushing the
"Enable CORS" button in the AWS API Gateway console. This is disabled by
default, but you may wish to enable it for APIs which are accssed from
other domains, etc.

You can also simply handle CORS directly in your application. If you do
this, you'll need to add ``Access-Control-Allow-Origin``,
``Access-Control-Allow-Headers``, and ``Access-Control-Allow-Methods``
to the ``method_header_types`` key in your ``zappa_settings.json``. See
further `discussion
here <https://github.com/Miserlou/Zappa/issues/41>`__.

Large Projects
--------------

AWS currently limits Lambda zip sizes to 50 megabytes. If your project
is larger than that, set ``slim_handler: true`` in your
``zappa_settings.json``. In this case, your fat application package will
be replaced with a small handler-only package. The handler file then
pulls the rest of the large project down from S3 at run time! The
initial load of the large project may add to startup overhead, but the
difference should be minimal on a warm lambda function. Note that this
will also eat into the *memory* space of your application function.

Enabling Bash Completion
------------------------

Bash completion can be enabled by adding the following to your .bashrc:

.. code:: bash

eval "$(register-python-argcomplete zappa)"

``register-python-argcomplete`` is provided by the argcomplete Python
package. If this package was installed in a virtualenv then the command
must be run there. Alternatively you can execute:

activate-global-python-argcomplete --dest=- > file

The file's contents should then be sourced in e.g. ~/.bashrc.

Enabling Secure Endpoints on API Gateway
----------------------------------------

API Key
~~~~~~~

You can use the ``api_key_required`` setting to generate and assign an
API key to all the routes of your API Gateway. After redeployment, you
can then pass the provided key as a header called ``x-api-key`` to
access the restricted endpoints. Without the ``x-api-key`` header, you
will receive a 403. You'll also need to manually associate this API key
with your usage plan in the AWS console. `More information on API keys
in the API
Gateway <http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html>`__.

IAM Policy
~~~~~~~~~~

You can enable IAM-based (v4 signing) authorization on an API by setting
the ``iam_authorization`` setting to ``true``. Your API will then
require signed requests and access can be controlled via `IAM
policy <https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-iam-policy-examples.html>`__.
Unsigned requests will receive a 403 response, as will requesters who
are not authorized to access the API. Enabling this will override the
Authorizer configuration (see below).

API Gateway Authorizers
~~~~~~~~~~~~~~~~~~~~~~~

If you deploy an API endpoint with Zappa, you can take advantage of `API
Gateway
Authorizers <http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html>`__
to implement a token-based authentication - all you need to do is to
provide a function to create the required output, Zappa takes care of
the rest. A good start for the function is the `awslabs blueprint
example. <https://github.com/awslabs/aws-apigateway-lambda-authorizer-blueprints/blob/master/blueprints/python/api-gateway-authorizer-python.py>`__

If you are wondering for what you would use an Authorizer, here are some
potential use cases:

1. Call out to OAuth provider
2. Decode a JWT token inline
3. Lookup in a self-managed DB (for example DynamoDB)

Zappa can be configured to call a function inside your code to do the
authorization, or to call some other existing lambda function (which
lets you share the authorizer between multiple lambdas). You control the
behavior by specifying either the ``arn`` or ``function_name`` values in
the ``authorizer`` settings block.

Cognito User Pool Authorizer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also use AWS Cognito User Pool Authorizer by adding:

.. code:: javascript

{
"authorizer": {
"type": "COGNITO_USER_POOLS",
"provider_arns": [
"arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}"
]
}
}

Deploying to a Custom Domain Name with SSL Certificates
-------------------------------------------------------

Deploying to a Domain With a Let's Encrypt Certificate (DNS Auth)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you want to use Zappa on a domain with a free Let's Encrypt
certificate using automatic Route 53 based DNS Authentication, you can
follow `this handy
guide <https://github.com/Miserlou/Zappa/blob/master/docs/domain_with_free_ssl_dns.md>`__.

Deploying to a Domain With a Let's Encrypt Certificate (HTTP Auth)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you want to use Zappa on a domain with a free Let's Encrypt
certificate using HTTP Authentication, you can follow `this
guide <https://github.com/Miserlou/Zappa/blob/master/docs/domain_with_free_ssl_http.md>`__.

However, it's now far easier to use Route 53-based DNS authentication,
which will allow you to use a Let's Encrypt certificate with a single
``$ zappa certify`` command.

Deploying with Custom Domain Name (with your own SSL Certs)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. The first step is to create a custom domain and upload your SSL cert
/ key / bundle - follow this guide `Set Up a Custom Domain Name for
an API Gateway
API <http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html#how-to-custom-domains-console>`__
2. Ensure you have set the ``domain`` setting within your Zappa settings
JSON - this will avoid problems with the Base Path mapping between
the Custom Domain and the API invoke URL, which gets the Stage Name
appended in the URI
3. Deploy or update your app using Zappa
4. Create a base path mapping between your custom domain name and your
chosen API stage, leaving the base-path blank if you wish to access
your app on the root path of your custom domain e.g. myapp.com rather
than myapp.com/prod

``$ aws apigateway create-base-path-mapping --domain-name myapp.com --rest-api-id 123abc --stage prod --base-path '' --region us-west-2``

Ensure you have a CNAME to resolve your custom domain name to the
CloudFront Distribution domain name which can be found using:

``$ aws apigateway get-domain-names``

There is an `open
ticket <https://github.com/Miserlou/Zappa/issues/401>`__ to automate
this process.

Setting Environment Variables
-----------------------------

Local Environment Variables
~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you want to set local remote environment variables for a deployment
stage, you can simply set them in your ``zappa_settings.json``:

.. code:: javascript

{
"dev": {
...
"environment_variables": {
"your_key": "your_value"
}
},
...
}

You can then access these inside your application with:

.. code:: python

import os
your_value = os.environ.get('your_key')

If your project needs to be aware of the type of environment you're
deployed to, you'll also be able to get ``SERVERTYPE`` (AWS Lambda),
``FRAMEWORK`` (Zappa), ``PROJECT`` (your project name) and ``STAGE``
(*dev*, *production*, etc.) variables at any time.

Please note that these are not the `AWS Lambda environment
variables <https://github.com/Miserlou/Zappa/issues/501>`__ that Amazon
now offers directly. These were implemented long before that feature was
available, and will not be available through your AWS console.

Remote Environment Variables
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you want to use remote environment variables to configure your
application (which is especially useful for things like sensitive
credentials), you can create a file and place it in an S3 bucket to
which your Zappa application has access to. To do this, add the
``remote_env`` key to zappa\_settings pointing to a file containing a
flat JSON object, so that each key-value pair on the object will be set
as an environment variable and value whenever a new lambda instance
spins up.

For example, to ensure your application has access to the database
credentials without storing them in your version control, you can add a
file to S3 with the connection string and load it into the lambda
environment using the ``remote_env`` configuration setting.

super-secret-config.json (uploaded to my-config-bucket):

.. code:: javascript

{
"DB_CONNECTION_STRING": "super-secret:database"
}

zappa\_settings.json:

.. code:: javascript

{
"dev": {
...
"remote_env": "s3://my-config-bucket/super-secret-config.json",
},
...
}

Now in your application you can use:

.. code:: python

import os
db_string = os.environ.get('DB_CONNECTION_STRING')

Catching Unhandled Exceptions
-----------------------------

By default, if an *unhandled* exception happens in your code, Zappa will
just print the stacktrace into a CloudWatch log. If you wish to use an
external reporting tool to take note of those exceptions, you can use
the ``exception_handler`` configuration option.

zappa\_settings.json:

.. code:: javascript

{
"dev": {
...
"exception_handler": "your_module.unhandled_exceptions",
},
...
}

The function has to accept three arguments: exception, event, and
context:

your\_module.py

.. code:: python

def unhandled_exception(e, event, context):
send_to_raygun(e, event) # gather data you need and send
return True # Prevent invocation retry

You may still need a similar exception handler inside your application,
this is just a way to catch exception which happen at the Zappa/WSGI
layer (typically event-based invocations, misconfigured settings, bad
Lambda packages, and permissions issues).

By default, AWS Lambda will attempt to retry an event based (non-API
Gateway, e.g. CloudWatch) invocation if an exception has been thrown.
However, you can prevent this by returning True, as in example above, so
Zappa that will not re-raise the uncaught exception, thus preventing AWS
Lambda from retrying the current invocation.

Using Custom AWS IAM Roles and Policies
---------------------------------------

By default, the Zappa client will create and manage the necessary IAM
policies and roles to execute Zappa applications. However, if you're
using Zappa in a corporate environment or as part of a continuous
integration, you may instead want to manually manage your remote
execution policies instead. (You can specify which *local* profile to
use for deploying your Zappa application by defining the
``profile_name`` setting, which will correspond to a profile in your AWS
credentials file.)

To manually define the permissions policy of your Zappa execution role,
you must define the following in your *zappa\_settings.json*:

.. code:: javascript

{
"dev": {
...
"manage_roles": false, // Disable Zappa client managing roles.
"role_name": "MyLambdaRole", // Name of your Zappa execution role. Default ZappaExecutionRole.
...
},
...
}

Ongoing discussion about the minimum policy requirements necessary for a
Zappa deployment `can be found
here <https://github.com/Miserlou/Zappa/issues/244>`__.

Globally Available Server-less Architectures
--------------------------------------------

.. raw:: html

<p align="center">

.. raw:: html

</p>

.. raw:: html

<p align="center">

Click to see slides from ServerlessConf London!

.. raw:: html

</p>

During the ``init`` process, you will be given the option to deploy your
application "globally." This will allow you to deploy your application
to all available AWS regions simultaneously in order to provide a
consistent global speed, increased redundancy, data isolation, and legal
compliance. You can also choose to deploy only to "primary" locations,
the AWS regions with ``-1`` in their names.

To learn more about these capabilities, see `these
slides <https://htmlpreview.github.io/?https://github.com/Miserlou/Talks/blob/master/serverless-london/global.html#0>`__
from ServerlessConf London.

Raising AWS Service Limits
--------------------------

Out of the box, AWS sets a limit of `100 concurrent
executions <http://docs.aws.amazon.com/lambda/latest/dg/limits.html>`__
for your functions. If you start to breach these limits, you may start
to see errors like
``ClientError: An error occurred (LimitExceededException) when calling the PutTargets.."``
or something similar.

To avoid this, you can file a `service
ticket <https://console.aws.amazon.com/support/home#/>`__ with Amazon to
raise your limits up to the many tens of thousands of concurrent
executions which you may need. This is a fairly common practice with
Amazon, designed to prevent you from accidentally creating extremely
expensive bug reports. So, before raising your service limits, make sure
that you don't have any rogue scripts which could accidentally create
tens of thousands of parallel executions that you don't want to pay for.

Zappa Guides
============

- `Django-Zappa tutorial
(screencast) <https://www.youtube.com/watch?v=plUrbPN0xc8&feature=youtu.be>`__.
- `Using Django-Zappa, Part
1 <https://serverlesscode.com/post/zappa-wsgi-for-python/>`__.
- `Using Django-Zappa, Part 2:
VPCs <https://serverlesscode.com/post/zappa-wsgi-for-python-pt-2/>`__.
- `Building Serverless Microservices with Zappa and
Flask <https://gun.io/blog/serverless-microservices-with-zappa-and-flask/>`__
- `Zappa で Hello World するまで
(Japanese) <http://qiita.com/satoshi_iwashita/items/505492193317819772c7>`__
- `How to Deploy Zappa with CloudFront, RDS and
VPC <https://jinwright.net/how-deploy-serverless-wsgi-app-using-zappa/>`__
- `Deploy Flask-Ask to AWS Lambda with Zappa
(screencast) <https://www.youtube.com/watch?v=mjWV4R2P4ks>`__
- `Secure 'Serverless' File Uploads with AWS Lambda, S3, and
Zappa <http://blog.stratospark.com/secure-serverless-file-uploads-with-aws-lambda-s3-zappa.html>`__
- `First Steps with AWS Lambda, Zappa and
Python <https://andrich.blog/2017/02/12/first-steps-with-aws-lambda-zappa-flask-and-python/>`__
- *Your guide here?*

Zappa in the Press
==================

- *`Zappa Serves Python, Minus the
Servers <http://www.infoworld.com/article/3031665/application-development/zappa-serves-python-web-apps-minus-the-servers.html>`__*
- *`Zappa lyfter serverlösa applikationer med
Python <http://computersweden.idg.se/2.2683/1.649895/zappa-lyfter-python>`__*
- *`Interview: Rich Jones on
Zappa <https://serverlesscode.com/post/rich-jones-interview-django-zappa/>`__*
- `Top 10 Python Libraries of
2016 <https://tryolabs.com/blog/2016/12/20/top-10-python-libraries-of-2016/>`__

Sites Using Zappa
=================

- `Zappa.io <https://www.zappa.io>`__ - A simple Zappa homepage
- `Zappatista! <https://blog.zappa.io>`__ - The official Zappa blog!
- `Mailchimp Signup
Utility <https://github.com/sasha42/Mailchimp-utility>`__ - A
microservice for adding people to a mailing list via API.
- `Zappa Slack
Inviter <https://github.com/Miserlou/zappa-slack-inviter>`__ - A
tiny, server-less service for inviting new users to your Slack
channel.
- `Serverless Image
Host <https://github.com/Miserlou/serverless-imagehost>`__ - A
thumbnailing service with Flask, Zappa and Pillow.
- `Gigger <https://www.gigger.rocks/>`__ - The live music industry's
search engine
- `Zappa BitTorrent
Tracker <https://github.com/Miserlou/zappa-bittorrent-tracker>`__ -
An experimental server-less BitTorrent tracker. Work in progress.
- `JankyGlance <https://github.com/Miserlou/JankyGlance>`__ - A
server-less Yahoo! Pipes replacement.
- `LambdaMailer <https://github.com/tryolabs/lambda-mailer>`__ - A
server-less endpoint for processing a contact form.
- `Voter Registration
Microservice <https://topics.arlingtonva.us/2016/11/voter-registration-search-microservice/>`__
- Official backup to to the Virginia Department of Elections portal.
- `FreePoll Online <https://www.freepoll.online>`__ - A simple and
awesome say for groups to make decisions.
- And many more!

Are you using Zappa? Let us know and we'll list your site here!

Related Projects
================

- `lambda-packages <http://github.com/Miserlou/lambda-packages>`__ -
Precompiled C-extension packages for AWS Lambda. Used automatically
by Zappa.
- `Mackenzie <http://github.com/Miserlou/Mackenzie>`__ - AWS Lambda
Infection Toolkit
- `zappa-cms <http://github.com/Miserlou/zappa-cms>`__ - A tiny
server-less CMS for busy hackers. Work in progress.
- `flask-ask <https://github.com/johnwheeler/flask-ask>`__ - A
framework for building Amazon Alexa applications. Uses Zappa for
deployments.
- `zappa-file-widget <https://github.com/anush0247/zappa-file-widget>`__
- A Django plugin for supporting binary file uploads in Django on
Zappa.
- `zops <https://github.com/bjinwright/zops>`__ - Utilities for teams
and continuous integrations using Zappa.
- `cookiecutter-mobile-backend <https://github.com/narfman0/cookiecutter-mobile-backend/>`__
- A ``cookiecutter`` Django project with Zappa and S3 uploads
support.
- `zappa-examples <https://github.com/narfman0/zappa-examples/>`__ -
Flask, Django, image uploads, and more!
- `Zappa Docker Image <https://github.com/danielwhatmuff/zappa>`__ - A
Docker image for running Zappa locally, based on Lambda Docker.
- `zappa-django-example <https://github.com/edgarroman/zappa-django-example>`__
- A complete example for running Django on Zappa.
- `zappa-dashing <https://github.com/nikos/zappa-dashing>`__ - Monitor
your AWS environment (health/metrics) with Zappa and CloudWatch.
- `s3env <https://github.com/cameronmaske/s3env>`__ - Manipulate a
remote Zappa environment variable key/value JSON object file in an S3
bucket through the CLI.
- `zappa\_resize\_image\_on\_fly <https://github.com/wobeng/zappa_resize_image_on_fly>`__
- Resize images on the fly using Flask, Zappa, Pillow, and
OpenCV-python.
- `gdrive-lambda <https://github.com/richiverse/gdrive-lambda>`__ -
pass json data to a csv file for end users who use Gdrive across the
organization.

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

- :sub:`[STRIKEOUT:Using VTL to map body, headers, method, params and
query strings into JSON, and then turning that into valid WSGI.]`
- :sub:`[STRIKEOUT: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.]`
- :sub:`[STRIKEOUT:Packing and *Base58* encoding multiple cookies into
a single cookie because we can only map one kind.]`
- Forcing the case permutations of "Set-Cookie" in order to return
multiple headers at the same time.
- :sub:`[STRIKEOUT:Turning cookie-setting 301/302 responses into 200
responses with HTML redirects, because we have no way to set headers
on redirects.]`

Contributing
============

This project is still young, so there is still plenty to be done.
Contributions are more than welcome!

Please file tickets for discussion before submitting patches. Pull
requests should target ``master`` and should leave Zappa in a
"shippable" state if merged.

If you are adding a non-trivial amount of new code, please include a
functioning test in your PR. For AWS calls, we use the ``placebo``
library, which you can learn to use `in their
README <https://github.com/garnaat/placebo#usage-as-a-decorator>`__. The
test suite will be run by `Travis
CI <https://travis-ci.org/Miserlou/Zappa>`__ once you open a pull
request.

Please include the GitHub issue or pull request URL that has discussion
related to your changes as a comment in the code
(`example <https://github.com/Miserlou/Zappa/blob/fae2925431b820eaedf088a632022e4120a29f89/zappa/zappa.py#L241-L243>`__).
This greatly helps for project maintainability, as it allows us to trace
back use cases and explain decision making.

Using a Local Repo
------------------

To use the git HEAD, you *probably can't* use ``pip install -e``.
Instead, you should clone the repo to your machine and then
``pip install /path/to/zappa/repo`` or
``ln -s /path/to/zappa/repo/zappa zappa`` in your local project.

Support / Development / Training / Consulting
=============================================

Do you need help with..

- Porting existing Flask and Django applications to Zappa?
- Building new applications and services that scale infinitely?
- Reducing your operations and hosting costs?
- Adding new custom features into Zappa?
- Training your team to use AWS and other server-less paradigms?

Good news! We're currently available for remote and on-site consulting
for small, large and enterprise teams. Please contact miserlou@gmail.com
with your needs and let's work together!

.. raw:: html

<p align="center">

.. raw:: html

</p>

.. |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
.. |Requirements Status| image:: https://requires.io/github/Miserlou/Zappa/requirements.svg?branch=master
:target: https://requires.io/github/Miserlou/Zappa/requirements/?branch=master
.. |PyPI| image:: https://img.shields.io/pypi/v/Zappa.svg
:target: https://pypi.python.org/pypi/zappa
.. |Slack| image:: https://img.shields.io/badge/chat-slack-ff69b4.svg
:target: https://slack.zappa.io/
.. |Gun.io| image:: https://img.shields.io/badge/made%20by-gun.io-blue.svg
:target: https://gun.io/