Deploy a Python Flask App
This guide explains how to deploy a Python application written using the Flask web framework to Koyeb using:
- Git-driven deployment to automatically build and deploy a new version of your application each time a change is detected on your branch.
- Pre-built containers you can deploy from any public or private registry.
To successfully follow this documentation, you will need to have a Koyeb account (opens in a new tab). You can optionally install the Koyeb CLI if you prefer to follow this guide without leaving the terminal.
You can deploy and preview the Flask application from this guide using the Deploy to Koyeb button below.
You can consult the repository on GitHub (opens in a new tab) to find out more about the example application that this guide uses.
Get started by creating a minimalistic Python application that we will deploy on Koyeb. You will need Python (opens in a new tab) installed on your machine.
In your terminal, run the following commands to create the directory that will hold the application code:
mkdir example-flask cd example-flask
In the folder you created, create a new virtual environment folder using
python -m venv venv. Virtual environments provide isolation from the system environment allowing each virtual environment you create to have its own installation directories, dependencies, etc.
Activate and load your virtual environment, type:
With your virtual environment active, install Flask, a minimal web framework, and create the
requirements.txt file to store the dependencies and versions of each package required to run the application.
pip install flask gunicorn pip freeze > requirements.txt
Create a new file called
app.py to store our minimalist Flask application code. In the snippet below, we define a route to handle requests for
/ and return "Hello from Koyeb" as a response:
from flask import Flask app = Flask(__name__) @app.route('/') def hello_world(): return 'Hello from Koyeb' if __name__ == "__main__": app.run()
Launch the application locally to make sure everything is running as expected.
You can now access the application at
In the project directory, initialize a new git repository by running the following command:
We will use this repository to version the application code and push the changes to a GitHub repository. If you don't have an existing GitHub repository to push the code to, you can create a new one and run the following commands to commit and push changes to your GitHub repository:
git add requirements.txt app.py git commit -m "Initial commit" git remote add origin email@example.com:<YOUR_GITHUB_USERNAME>/<YOUR_REPOSITORY_NAME>.git git push -u origin main
Make sure to replace
<YOUR_GITHUB_USERNAME>/<YOUR_REPOSITORY_NAME> with your GitHub username and repository name.
To deploy the Python app to Koyeb using the control panel (opens in a new tab), follow the steps below:
- Click Create App in the Koyeb control panel.
- Select GitHub as the deployment option.
- Choose the GitHub repository and branch containing your application code.
- Name your service, for example
- Name the App, for example
- Click the Deploy button.
A Koyeb App and Service will be created. Your application will be built and deployed to Koyeb. Once the build has finished, you will be able to access your application running on Koyeb by clicking the URL ending with
As an alternative to using git-driven deployment, you can deploy a pre-built container from any public or private registry. This can be useful if your application needs specific system dependencies or you need more control over how the build is performed.
To dockerize the Python application, create a
Dockerfile in your project root directory and copy the content below:
FROM python:3-alpine AS builder WORKDIR /app RUN python3 -m venv venv ENV VIRTUAL_ENV=/app/venv ENV PATH="$VIRTUAL_ENV/bin:$PATH" COPY requirements.txt . RUN pip install -r requirements.txt # Stage 2 FROM python:3-alpine AS runner WORKDIR /app COPY --from=builder /app/venv venv COPY app.py app.py ENV VIRTUAL_ENV=/app/venv ENV PATH="$VIRTUAL_ENV/bin:$PATH" ENV FLASK_APP=app/app.py EXPOSE 8080 CMD ["gunicorn", "--bind" , ":8080", "--workers", "2", "app:app"]
The Dockerfile above provides the minimum requirements to run the Python application. You can easily extend it depending on your needs.
To build and push the Docker image to a registry and deploy it on Koyeb, refer to the page on deploying pre-built container images.