now-python-wsgi
A Now builder for Python WSGI applications
Quickstart
If you have an existing WSGI app, getting this builder to work for you is a
piece of
1. Add a Now configuration
Add a now.json
file to the root of your application:
{
"version": 2,
"name": "python-wsgi-app",
"builds": [{
"src": "index.py",
"use": "@ardent-labs/now-python-wsgi",
"config": { "maxLambdaSize": "15mb" }
}]
}
This configuration is doing a few things in the "builds"
part:
-
"src": "index.py"
This tells Now that there is one entrypoint to build for.index.py
is a file we'll create shortly. -
"use": "@ardent-labs/now-python-wsgi"
Tell Now to use this builder when deploying your application -
"config": { "maxLambdaSize": "15mb" }
Bump up the maximum size of the built application to accommodate some larger python WSGI libraries (like Django or Flask). This may not be necessary for you.
2. Add a Now entrypoint
Add index.py
to the root of your application. This entrypoint should make
available an object named application
that is an instance of your WSGI
application. E.g.:
# For a Dango app
from django_app.wsgi import application
# Replace `django_app` with the appropriate name to point towards your project's
# wsgi.py file
Look at your framework documentation for help getting access to the WSGI application.
If the WSGI instance isn't named application
you can set the
wsgiApplicationName
configuration option to match your application's name (see
the configuration section below).
3. Deploy!
That's it, you're ready to go:
$ now
> Deploying python-wsgi-app
...
> Success! Deployment ready [57s]
Requirements
Your project may optionally include a requirements.txt
file to declare any
dependencies. If you do include a requirements file, Werkzeug
must appear as
a dependency, e.g.:
# requirements.txt
Werkzeug >=0.14,<1
If no requirements.txt
file is included, then the builder will install
Werkzeug
to ensure handler dependencies are met.
Configuration options
runtime
Select the lambda runtime. Defaults to python3.6
.
{
"builds": [{
"config": { "runtime": "python3.6" }
}]
}
wsgiApplicationName
Select the WSGI application to run from your entrypoint. Defaults to
application
.
{
"builds": [{
"config": { "wsgiApplicationName": "application" }
}]
}
Additional considerations
Lambda environment limitations
At the time of writing, Zeit Now runs on AWS Lambda. This has a number of implications on what libaries will be available to you, notably:
- PostgreSQL, so psycopg2 won't work out of the box
- MySQL, so MySQL adapters won't work out of the box either
- Sqlite, so the built-in Sqlite adapter won't be available
Contributing
To-dos
- [ ] Add tests for various types of requests
Attribution
This implementation draws upon work from: