Flask Gunicorn with production WSGI server

TL;DR To run a scalable Flask app, use Gunicorn with a production WSGI server like uWSGI or Nginx as a reverse proxy. Set up your virtual environment, install Flask and Gunicorn, create a basic app, and run it with Gunicorn using gunicorn -w 4 --bind unix:/tmp/myapp.sock myapp:app. Finally, use Nginx to serve your app in production.

Scaling Your Flask App: A Step-by-Step Guide to Running with Gunicorn and a Production WSGI Server

As a full-stack developer, you're likely no stranger to the ease of use and flexibility offered by Python's Flask framework. But as your application grows in popularity, you'll soon find yourself facing scalability issues that can't be resolved with a simple flask run command. That's where Gunicorn comes in – a popular and light WSGI server designed specifically for production environments.

In this article, we'll delve into the world of running Flask applications with Gunicorn and a production WSGI server. We'll cover everything from setting up your virtual environment to deploying your app on a production-ready platform.

Step 1: Setting Up Your Virtual Environment

Before we dive into the world of WSGI servers, let's ensure our development environment is set up correctly. For this example, we'll use Python 3.9 and the latest version of Flask.

# Install virtualenv and create a new environment
pip install virtualenv
virtualenv myenv

# Activate your new environment
source myenv/bin/activate

# Install Flask and Gunicorn
pip install flask gunicorn

Step 2: Creating Your Flask App

Next, let's create a basic Flask app to demonstrate how we can run it with Gunicorn.

from flask import Flask

app = Flask(__name__)

@app.route("/")
def index():
    return "Hello, World!"

if __name__ == "__main__":
    app.run(debug=True)

Run this script using flask run, and you should see your app serving on http://127.0.0.1:5000/.

Step 3: Running with Gunicorn

Now that we have our Flask app up and running, it's time to switch to Gunicorn. We'll use the following command to start our app:

gunicorn -w 4 --bind unix:/tmp/myapp.sock myapp:app

Here's what each flag does:

• -w specifies the number of worker processes (in this case, 4)
• --bind tells Gunicorn to listen on a specific socket (in this case, a Unix socket at /tmp/myapp.sock)
• myapp:app specifies the app name and entry point

Run this command in your terminal, and you should see your Flask app serving with Gunicorn.

Step 4: Using a Production WSGI Server

Gunicorn is great for development and testing, but it's not designed for production use. For that, we need a more robust WSGI server like uWSGI or Gunicorn behind a reverse proxy. Let's set up Nginx as our reverse proxy.

First, install Nginx:

sudo apt-get update && sudo apt-get install nginx

Next, create an Nginx configuration file (/etc/nginx/sites-available/myapp) with the following contents:

server {
    listen 80;
    server_name example.com;

    location / {
        include proxy_params;
        proxy_pass http://unix:/tmp/myapp.sock;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

Finally, enable the Nginx site and reload the service:

sudo ln -s /etc/nginx/sites-available/myapp /etc/nginx/sites-enabled/
sudo service nginx reload

Conclusion

In this article, we've covered how to run Flask applications with Gunicorn and a production WSGI server. We've taken our app from a simple flask run command to a robust, scalable setup using Nginx as our reverse proxy.

Whether you're building a small personal project or a large-scale enterprise application, following these steps will ensure your Flask app is ready for the demands of production.