Skip to main content

Serverless Django With AWS Lambda + API Gateway

Project description

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.

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

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!

Project details


Download files

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

Source Distribution

django-zappa-0.4.0.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

django_zappa-0.4.0-py2-none-any.whl (12.6 kB view details)

Uploaded Python 2

File details

Details for the file django-zappa-0.4.0.tar.gz.

File metadata

File hashes

Hashes for django-zappa-0.4.0.tar.gz
Algorithm Hash digest
SHA256 89628ee658962b7254d46ae6099d168a07c91d9d0ec38fdef4706fd0b8f6effd
MD5 19a9b47bb4d39857c122e8d258ea9157
BLAKE2b-256 7e4c70fae43b606974558dacd4727ad66db53e8a60b4231263d8357852d4f513

See more details on using hashes here.

Provenance

File details

Details for the file django_zappa-0.4.0-py2-none-any.whl.

File metadata

File hashes

Hashes for django_zappa-0.4.0-py2-none-any.whl
Algorithm Hash digest
SHA256 e54cbc0296f00b636fe97537f954f72110eee677c51c3fa8d87c0d78a27f48bb
MD5 50ac34ebfb17976008b822aa5c54b783
BLAKE2b-256 fa1bcdbba89dcc033f55d02997fea57494857bece3bba32d6f944af2c0aa1874

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