Skip to main content

Logo placeholder # django-zappa Build Status #### Serverless Django with AWS Lambda + API Gateway

django-zappa makes it super easy to deploy Django applications on AWS Lambda + API Gateway. Think of it as “serverless” web hosting for your Django apps. See in action here!

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!

  • No more worrying about security vulernabilities and patches!

django-zappa 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

Awesome!

This project is for Django-specific integration. If you are intersted in how this works under the hood, you should look at the `Zappa core library <https://github.com/Miserlou/Zappa>`__, which can be used by any WSGI-compatible web framework.

Installation

$ pip install django-zappa

Configuration

There are a few settings that you must define before you deploy your application. First, you must have your AWS credentials stored in ~/.aws/credentials’.

Finally, define a ZAPPA_SETTINGS setting in your local settings file which maps your named deployment environments to deployed settings and an S3 bucket (which must already be created). These can be named anything you like, but you may wish to have seperate dev, staging and production environments in order to separate your data.

ZAPPA_SETTINGS = {
    'production': {
       's3_bucket': 'production-bucket',
       'settings_file': '~/Projects/MyApp/settings/production_settings.py',
    },
    'staging': {
       's3_bucket': 'staging-bucket',
       'settings_file': '~/Projects/MyApp/settings/staging_settings.py',
    },
}

Notice that each environment defines a path to a settings file. This file will be used as your server-side settings file. Specifically, you will want to define a new SECRET_KEY, as well as your deployment DATABASES information.

A Note About Databases

Since Zappa requirements are called from a bundled version of your local environment and not from pip, and because we have no way to determine what platform our Zappa handler will be executing on, we need to make sure that we only use portable packages. So, instead of using the default MySQL engine, we will instead need to use mysql-python-connector.

That means your app’s settings file will need an entry that looks like something this (notice the Engine field):

DATABASES = {
    'default': {
        'ENGINE': 'mysql.connector.django',
        'NAME': 'your_db_name',
        'USER': 'your_db_username',
        'PASSWORD': 'your_db_password',
        'HOST': 'your_db_name.your_db_id.us-east-1.rds.amazonaws.com',
        'PORT': '3306',
    }
}

Middleware

Zappa requires special middleware for handling cookies, so in your remote settings file, you must include ZappaMiddleware as the first item in your MIDDLEWARE_CLASSES:

MIDDLEWARE_CLASSES = (
    'django_zappa.middleware.ZappaMiddleware',
    ...
)

Currently, Zappa only supports MySQL and Aurora on RDS.

Basic Usage

Initial Deployments

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

$ python manage.py 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?!

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:

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

Management

If you want to invoke Django management commands on the remote Zappa instance, you simply call the ‘invoke’ management command locally:

$ python manage.py invoke production check
System check identified no issues (0 silenced).

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:

  • ORM/DB support

  • Testing

  • Route53 Integration

  • SSL Integration

  • Package size/speed optimization

  • Fix the “hot-start” problem

  • Feedback

  • A nifty logo

  • Real documentation / website!

Metadata

Release files for django-zappa 0.8.0

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

Source distribution (sdist)

Source distribution for django-zappa 0.8.0
File Size Uploaded Provenance Actions
django-zappa-0.8.0.tar.gz 9.4 kB Without provenance Details for django-zappa-0.8.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for django-zappa 0.8.0
File Interpreter ABI Platform Actions
django_zappa-0.8.0-py2-none-any.whl Python 2 none any Details for django_zappa-0.8.0-py2-none-any.whl

Total release size: 24.5 kB

Release files / django-zappa-0.8.0.tar.gz

Download URL django-zappa-0.8.0.tar.gz
Size 9.4 kB
Tags Source
SHA-256 checksum
How to use checksums
126023cdec50e4da72041512bc644a398c861638a4f9a9b2247d8fde66bee68d
BLAKE2b-256 checksum
How to use checksums
9941adf32d3e51ec674606977617fa8234073a451602a3f263d642a5974f7b2b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / django_zappa-0.8.0-py2-none-any.whl

Download URL django_zappa-0.8.0-py2-none-any.whl
Size 15.1 kB
Tags Python 2
SHA-256 checksum
How to use checksums
cc0ac32fd6a1ccc4c3d80add6ff915f77bf34cb1371ab899a69108aad8f19a56
BLAKE2b-256 checksum
How to use checksums
12d876827b5aed53e5b20e37026b28e1f74680cc393c1eceb6e4d9d79000cf41
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for django-zappa 0.8.0

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.

Release history Release notifications | RSS feed

This release

0.8.0 This release

2 release files No provenance

0.0.1

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