-
install dependencies using Poetry
poetry install
-
configure environment variables in
.env
file -
start bot in virtual environment
poetry run python -m bot
-
configure environment variables in
.env
file -
start virtual environment
poetry shell
-
building the docker image
docker-compose build
-
start service
docker-compose up -d
variables | description |
---|---|
BOT_TOKEN |
Telegram bot API token |
PG_HOST |
hostname or an IP address PostgreSQL database |
PG_NAME |
the name of the PostgreSQL database |
PG_PASSWORD |
password used to authenticate |
PG_PORT |
connection port number (defaults to 5432 if not provided) |
PG_USER |
the username used to authenticate |
REDIS_HOST |
hostname or an IP address Redis database |
REDIS_PASSWORD |
Redis database password, empty by default |
REDIS_PORT |
port from Redis database |
I use Redis for Finite State Machine, and PostgreSQL as Database
aiogram
— asynchronous framework for Telegram Bot APIasyncpg
— asynchronous PostgreSQL database client librarypoetry
— development workflowloguru
— third party library for logging in Pythondocker
— to automate deploymentpostgres
— powerful, open source object-relational database systemredis
— an in-memory data structure store
First off, thanks for taking the time to contribute! Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
Fork
this repository- Create a
branch
Commit
your changesPush
yourcommits
to thebranch
- Submit a
pull request
Distributed under the GPL-3.0 license. See LICENSE
for more information.