How to Deploy a Telegram Bot with Flask, pyTelegramBotAPI, Gunicorn and PostgreSQL to Heroku

Over the course of several months, I have been building Telegram bots as a hobby and also for clients but so far, I had no reason to build a bot that will make use of Webhooks, PostgreSQL and Flask framework.

Previously, most of my Telegram bots were built as a single python file connected to a Google Spreadsheet as a database and deployed to Heroku as explained in my previous guide — “How to Deploy a Python Script or Bot to Heroku in 5 Minutes”.

Building a Telegram bot with Flask, Gunicorn and a database like PostgreSQL is a different ball game and it becomes more interesting when you add Heroku deployment to the mix.

When I was done building my last Telegram bot project and was ready to deploy it, I couldn’t find any comprehensive guide or tutorial that explained everything I needed to add and configure in order to successfully deploy my Bot; there was no single documentation where I could find all the needed information in one place, most of the tutorials out there are geared towards the deployment of a flask website and not a telegram bot living in a “flask container”.

Anyways, I was able to pull it off after hours of trials and figuring things out on my own but you don't have to go through that stress because I have made this guide for you and I hope it will be enough for you to successfully deploy your awesome Telegram Bot to Heroku.

In this step-by-step guide, I will show you how to deploy a Telegram Bot with Flask, pyTelegramBotAPI, Gunicorn, and PostgreSQL to Heroku.

In this guide, I am using Flask 1.1.2 and pyTelegramBotAPI to build the bot. For some reason, Flask 2.0+ has an issue with SQLAlchemy with throws an error (please don't ask me why!), but after some research, I found a solution that involves downgrading my Flask to 1.1.2+ version.

So, you might need to change your Flask version in your requirements.txt file but don’t worry about this if you are able to make your Flask + telegram bot work successfully with your Database even with a newer version of Flask.

That said, let’s move on with our Telegram Bot with Flask and PostgreSQL deployment to Heroku.

I will try to make the steps as simple as possible but I will assume you are familiar with Python & Git (I am assuming your project is a git repository) and you have built a Telegram bot Flask, PostgreSQL, and pyTelegramBotAPI.

Tip : You can activate git in your project folder by running the command git init in your terminal.

Let’s Get Started:

So here we use,

Steps we follow here:

  1. Install Heroku CLI
  2. Create a new Heroku app
  3. Install required Packages (Gunicorn & PythonDecouple)
  4. Create configurations
  5. Create a database on Heroku
  6. Setup Environment variables
  7. Database Configuration
  8. Bot Deployment
  9. Database migration
  10. Troubleshooting
  11. Testing

1. Install Heroku CLI

You need to install the Heroku CLI on your computer for easy deployment and troubleshooting, the CLI comes with some nice features that will be helpful to you on your deployment journey.

To install the Heroku CLI on your Computer follow the procedure here for all OS https://devcenter.heroku.com/articles/heroku-cli)

You can skip this step if you already have Heroku installed on your computer.

2. Create a new Heroku app

Go to the Heroku website (heroku.com), log in and create a new App; choose a meaningful name for your App.

3. Install required Packages (Gunicorn, FlaskSqlAlchemy, psycopg2 & PythonDecouple)

  • Gunicorn is a Python WSGI HTTP Server for UNIX. The Gunicorn server is broadly compatible with various web frameworks such as Flask. You can install Gunicorn by using: 
pip install gunicorn
  • I assume you already have Flask SQLAlchemy installed in your project and you are already using it to connect your bot to your PostgreSQL database.

if you don’t have it, you can install it by using the command below and check it’s documentation for how to implement it in your app.

pip install flask_sqlalchemy

These two packages will be responsible for your web server and database connection respectively.

  • Python Decouple helps you to organize your settings so that you can change parameters without having to redeploy your app using the environment variables. it’s my favorite tool for handling .env file.

if you don’t have it, you can install it by using the command below and check it’s documentation for how to implement it in your app.

pip install python-decouple
  • Another important package you will need is called “psycopg2”. Psycopg is the most popular PostgreSQL database adapter for the Python programming language.

if you don’t have it, you can install it by using the command below and check it’s documentation for how to implement it in your app.

pip install psycopg2

4. Create configurations

Before you can deploy an app to Heroku, you need to add two important configuration files which are the Procfile & requirements.txt file

Procfile Setup

Open your project in your favorite code Editor or Navigate to your project directory and create a file named Procfile

Next, using any code editor like VSCode or TextEdit, open the Profile, and replace any text already prevalent with:

web: gunicorn app:app

Tip : The line above is designating which python script you want to be able to execute through the webserver. In this above example, the “app” by the left of “app:app” is the name of the python file in which I have my Telegram bot, so my telegram bot python file is named “app.py”.

if your bot python file is named something else, please change it to the correct one. For example, if your python file is named “bot.py” you will have:

web: gunicorn bot:app

Note : There should be no suffix like “.txt” at the end of your Procfile name, it’s just Procfile

Requirements.txt File Setup

The requirements.txt file makes it easier for Heroku to install the correct versions of the required Python libraries (or “packages”) to run your Python code.

We are going to tell Heroku packages to install using our requirements.txt

Open Your project folder On your Command Line Interface (CLI) inside your environment use the following command:

pip freeze> requirements.txt

this should automatically generate a requirements.txt file for you with all dependencies and libraries used in your App listed in the file.

runtime.txt File Setup

The runtim.txt file allows you to specify the Python version that you are using in your application, this is useful to ensure compatibility and avoid python version problems. Below is an example:

python-3.8.10

change this to your own Python version.

5. Create a database on Heroku

Now, it is almost time to deploy our Telegram bot to Heroku but before that, we need to configure some important things especially a database.

To do this, Open Your project folder On your Command Line Interface (CLI) inside your environment use the following command:

heroku login

heroku git:remote -a NAME_OF_YOUR_HEROKU_APP

heroku addons:create heroku-postgresql:hobby-dev

Once you execute all the commands above, your local app should be linked to your remote Heroku git repository and a PostgreSQL database should have been created for your app.

Now, log in to your Heroku dashboard, click on the Settings menu and then on the button Reveal Config Vars: by default you should have DATABASE_URI configuration created after installing Postgres to Heroku. You can also add all the environment variables here.

6. Setup environment variables

If your bot uses a .env file or if it relies on variables found through Python’s os.environ, you must set them as well in order for your script to work. Typically a Telegram bot requires a token from Bot Father, this is where you add the token.

Just use Heroku’s config:set

heroku config:set [KEY_NANE=value …]

example,

heroku config:set TOKEN=jfuurhj7367edjkjfkkjrfhre8nfdj

this will set my TOKEN environment variable to that value.

7. Database Configuration

Well, I had to figure out this part the hard way, after my initial deployment, I was having issues with the bot, it kept crashing especially when it comes to database migration until I found the issue which is definitely not my fault.

I was fortunate enough to find this stackoverflow answer and this answer that solved it.

The problem is that SQLAlchemy 1.4 removed the deprecated postgres dialect name, the name postgresql must be used instead now. The dialect is the part before the :// in the URL. SQLAlchemy 1.3 and earlier showed a deprecation warning but still accepted it.

To fix this, rename postgres:// in the URL to postgresql://.

This error currently shows up when working with Heroku, which uses postgres in the DATABASE_URL they provide, which you probably use for SQLALCHEMY_DATABASE_URI. To work around this until they update it, update the variable in the Heroku dashboard to use postgresql.

import os
import re

uri = os.getenv("DATABASE_URL") # or other relevant config var
if uri.startswith("postgres://"):
    uri = uri.replace("postgres://", "postgresql://", 1)
# rest of connection code using the connection string `uri`

Use the above snippet in your code and set SQLALCHEMY_DATABASE_URI = uri

app.config['SQLALCHEMY_DATABASE_URI'] = uri

8. Bot Deployment

Right now, we have our environment variables setup, we have our database configured and we have all configuration files in place; the next thing is to now deploy our app to Heroku.

follow the steps below to deploy your app.

git add .

git commit -m "Deployment commit"

git push heroku master

From your terminal, you can see your app deployment process and you can see it when the deployment process is completed.

But wait, we are not yet done!

9. Database migration

Right now, your flask app and Telegram bot have been deployed to Heroku but your database is not yet completely set up.

In order to use a database, you need to create the database tables and you can easily do this through the Heroku CLI. follow the procedures below to create your database tables so that your bot can save data into the database.

from your terminal, execute:

heroku run python3
>>> from app import db
>>> db.create_all()

If you didn’t get an error, then your database is configured properly!

10. Troubleshooting

Truth is, even though I have outlined all the necessary steps here, your deployed app may not work for one reason or the other. On this note, I will share some common issues and troubleshooting tips here.

  • App crashing error

the first thing to do if your app is not working (http://heroku-app.heroku.com) is to go to your CLI and check the logs using

_heroku logs --tail_

This command will show you the error log and you can read through it to find out what is making the app crash. When you are done, press Ctrl+C to return to the prompt.

  • Database error 
ImportError: cannot import name 'db' from 'app' (unknown location)

db is not located in app in your application. Find where it's defined and import it from there or check the name of your app file, it could be “bot.py”.

  • Create a virtual env and install all packages. Ensure you have psycopg2 and gunicorn

  • Debug = True. You need to set Debug = False in your Flask Application when deploying to Heroku; Heroku usually does not allow you to run a production app in debug mode and it can cause your app to crash.

  • Flask Server Port

As you should know, Telegram bots do not work with the default port “5000” that comes with Flask, It works with ports 443, 80, 88 or 8443.

I was getting some server errors and my app was crashing due to this port issue until I was able to detect it and fix it. So, below is a perfect Flask server configuration that will save you a lot of time. Just use the host and port as specified below and you will be fine.

# Start Flask Server
if __name__ == "__main__":
app.run(host='0.0.0.0', port=int(os.environ.get('PORT', 5000)))

11. Testing

At this stage, if everything has gone well, your Telegram bot should be working perfectly.

You can open your Telegram App and send a message to your bot and it should respond within few seconds.

Conclusion

If you followed the simple steps in this article, you should be able to successfully deploy your Telegram Bot with Flask, pyTelegramBotAPI, Gunicorn, and PostgreSQL to Heroku using the Command-Line and the Heroku interface.

If you liked this article please share it with your network and don’t forget to follow me for more great articles and tutorials.

16

Kategorien:

Python

Tags:

DeploymentHerokuTelegrambotPython