Serverless Django With AWS Lambda + API Gateway
Project description
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',
}
}At time of writing, there seems to be a problem with the Python MySQL connector when calling the initial ‘migrate’. You can remedy this by using the usual ‘django.db.backends.mysql’ for your initial migration from your local machine and just using ‘mysql.connector.django’ in your remote settings.
Currently, Zappa only supports MySQL and Aurora on RDS.
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',
...
)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).
Advanced Usage
There are other settings that you can define in your ZAPPA_SETTINGS to change Zappa’s behavior. Use these at your own risk!
ZAPPA_SETTINGS = {
'dev': {
'aws_region': 'us-east-1', # AWS Region (default US East),
'http_methods': ['GET', 'POST'], # HTTP Methods to route,
'integration_response_codes': [200, 301, 404, 500], # Integration response status codes to route
'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)
}
}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!
Route53/SSL Integration!
Fix the “hot-start” problem!
Feedback!
Real documentation / website!
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
Built Distribution
Hashes for django_zappa-0.9.1-py2-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1685835c835f0004303616996143d945b567bb44370f7d8ae22c0077ab9d8728 |
|
| MD5 | 52afa2fa6181c1397dc9d458574c0f24 |
|
| BLAKE2b-256 | a41a94b832666723992f03328b4aa30bcef21181780b809ef72bf207f03edfe8 |
