@ardnt/vercel-python-wsgi
v1.1.1
Published
Python builder for WSGI applications on Vercel
Downloads
246
Readme
vercel-python-wsgi
A Vercel 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 Vercel configuration
Add a vercel.json
file to the root of your application:
{
"builds": [{
"src": "index.py",
"use": "@ardnt/vercel-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": "@ardnt/vercel-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:
$ vercel
> Deploying python-wsgi-app
...
> Success! Deployment ready [57s]
Requirements
Your project may optionally include a requirements.txt
file to declare any
dependencies, e.g.:
# requirements.txt
Django >=2.2,<2.3
Be aware that the builder will install Werkzeug
as a requirement of the
handler. This can cause issues if your project requires a different version of
Werkzeug
than the handler.
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
Routing
You'll likely want all requests arriving at your deployment url to be routed to your application. You can do this by adding a route rewrite to the Now configuration:
{
"builds": [{
"src": "index.py",
"use": "@ardnt/vercel-python-wsgi"
}],
"routes" : [{
"src" : "/(.*)", "dest":"/"
}]
}
Avoiding the index.py
file
If having an extra file in your project is troublesome or seems unecessary, it's
also possible to configure Now to use your application directly, without passing
it through index.py
.
If your WSGI application lives in vercel_app/wsgi.py
and is named application
,
then you can configure it as the entrypoint and adjust routes accordingly:
{
"builds": [{
"src": "vercel_app/wsgi.py",
"use": "@ardnt/vercel-python-wsgi"
}],
"routes" : [{
"src" : "/(.*)", "dest":"/vercel_app/wsgi.py"
}]
}
Lambda environment limitations
At the time of writing, Vercel 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: