https://github.com/sigseg5/python-telegram-bot-docker-heroku-template
This is a Python telegram bot template for run it locally, run in Docker directly or deploy it on Heroku by Heroku Container Registry
https://github.com/sigseg5/python-telegram-bot-docker-heroku-template
docker-telegram heroku-telegram telegram-bot
Last synced: 3 months ago
JSON representation
This is a Python telegram bot template for run it locally, run in Docker directly or deploy it on Heroku by Heroku Container Registry
- Host: GitHub
- URL: https://github.com/sigseg5/python-telegram-bot-docker-heroku-template
- Owner: sigseg5
- License: mit
- Created: 2020-11-03T07:48:16.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-02-20T20:29:06.000Z (8 months ago)
- Last Synced: 2025-04-11T17:19:52.498Z (6 months ago)
- Topics: docker-telegram, heroku-telegram, telegram-bot
- Language: Python
- Homepage:
- Size: 38.1 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Python Telegram bot template for run it locally, run in Docker directly or deploy it on Heroku by Heroku Container Registry
This is a Python telegram bot template for run it locally, run in Docker directly or deploy it on Heroku by Heroku Container Registry
## Requirements
* Telegram account
* (Optional) Installed [Docker](https://www.docker.com/)
* (Optional) Heroku account
* (Optional) Heroku CLI Tool
## Run locally
* Add `TOKEN` and `MODE` environment variables to you IDE config e.g. PyCharm. You can get token from [BotFather](https://www.t.me/BotFather) at Telegram. For local running you can set `MODE=dev`
E.g. ENV_VAR: `PYTHONUNBUFFERED=1;TOKEN=1234567890:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx;MODE=dev`
* Run `pip install -r requirements.txt` to install dependencies
* Run `bot.py` to start
## Run in Docker
* (Optional) Specify Python version at Dockerfile
* Add TOKEN to .env file. You can get token from [BotFather](https://www.t.me/BotFather) at Telegram
* (Optional) Run `pip freeze > requirements.txt` to add your own dependencies installed by `pip`
* Run `docker build --tag app_name:1.0 .` for build image
* (Optional) Run `docker run --env-file .env app_name:1.0 env` for view all environment variables for this image
* Run `docker run --env-file .env test:1.0` to start
## Results
After running bot.py using your preferred option, you will get:
`2018–12–14 15:12:21,500 — root — INFO — Starting bot`
If you go to your bot in Telegram and press Start button, you will get:
`2018–12–14 15:12:36,617 — root — INFO — User started bot`
And if you type /random command, you will get:
`2018–12–14 15:12:38,238 — root — INFO — User randomed number 2`
## Remove image
* Run `docker images` to view list of all images
* Run `docker rmi -f `
## Stop container
* Run `docker stats` to view all running containers
* Run `docker kill `
## Deploy on Heroku
Detailed guidance in [this](https://medium.com/python4you/creating-telegram-bot-and-deploying-it-on-heroku-471de1d96554) article
To launch your bot in Heroku you should go through the next steps:
* Create an account or use an existing one
* Create an application (remember about `HEROKU_APP_NAME`)
* Specify environmental variables in Settings tab of your application (`MODE=prod`, `TOKEN` `HEROKU_APP_NAME`)
* Setting env variables.
You can read full instructions about deploying images to Heroku [here](https://devcenter.heroku.com/articles/container-registry-and-runtime).
Go to the directory where you place bot.py, Dockerfile and execute next steps:
* Download Heroku CLI here
* Login
`heroku container:login`
* Build and push an image
`heroku container:push --app web`
* Create a new release
`heroku container:release --app web`
* Watch logs
`heroku logs --tail --app `
After some time, you should be able to see logs of your bot.
## Note
This repository based on this [repo](https://github.com/artemrys/python-telegram-bot-heroku-example) and [article](https://medium.com/python4you/creating-telegram-bot-and-deploying-it-on-heroku-471de1d96554) with some improvements and instructions, big thanks to Artem Rys!