fumofumo_plush_bot

Silly telegram bot. Will welcome new users in the group and notify if someone has left. Users can propose posts to the channel with private messages.

https://t.me/fumofumo_plush_bot

Used technologies

• Python 3 with asyncio, data validation and typing
• aiogram 3
• sqlalchemy asyncio wth SQLite for development or Postgres for production
• Docker and Docker Compose
• GitHub workflow linter and build

environment variables

• TELEGRAM_BOT_TOKEN=Your_token
• LOG_LEVEL=INFO loglevel
• ADMIN_CHAT_ID=238637902 To get ADMIN_CHAT_ID start bot and send him /id command
• HASH_SALT Optional salt for hashing.
• TIMEZONE Timezone for scheduler and commands that work with time. If not provided - UTC timezone wil be used.

env for postgres (if they are not specified, then sqlite will be used):

• POSTGRES_HOST postgress db host
• POSTGRES_PORT postgress db port
• POSTGRES_DB postgress db name
• POSTGRES_USER postgress db user
• POSTGRES_PASSWORD postgress db password

messages located in file app/messages.yml and can be redefined using docker volume. user_full_name will be replaced with user full name

To get sticker id start bot and send him /get_stickers_id command from admin.

To add fumos to db start bot and send him /add_fumos command from admin. Send fumo images with names. Telegram allows sharing stickers between bots, but each bot has a unique file_id for other media, so you have to re-upload them.

Run container

docker run -it --rm \
--env TELEGRAM_BOT_TOKEN="Your_token" \
--env ADMIN_CHAT_ID=238637902 \
ghcr.io/fstream7/fumofumo_plush_bot:main

Run container in detach/daemon mode

docker run --detach --restart=always \
--env TELEGRAM_BOT_TOKEN="Your_token" \
--env ADMIN_CHAT_ID=238637902 \
--name fumofumo_plush_bot \
ghcr.io/fstream7/fumofumo_plush_bot:main

Installation

1. Clone repo:

git clone [email protected]:Fstream7/fumofumo_plush_bot.git

2. Add env:

export TELEGRAM_BOT_TOKEN="Your_token"
export ADMIN_CHAT_ID=238637902

3. Run with local python

pip3 install requirements.txt
cd app/
alembic upgrade head
python main.py

Or with docker compose

# for development, with sqlite
docker compose -f docker-compose-dev.yml up
# for production, with postgres
docker compose -f docker-compose.yml up -d 

Commands:

• /id will return current chat id
• /fumo will return random fumo face ᗜᴗᗜ
• /fumofumo will return fumo of the day based on day and user id.

Admin commands:

• /get_stickers_id FSM, will return given sticker id
• /add_fumo FSM for adding fumos to db
• /cancel exit from FSM
• /list_fumos list all fumos in db.
• /list_fumos name list fumos by name in db. List all if name not provided.
• /update_fumo_cache Fumos cache updating daily, you can manually update it with this command
• /download_fumo_images name Download fumo images from bot. For backup or transfer between bots. Download all if name not provided.
• /import_fumo_images name Import fumo images. Bot will uppload images located in media/photos/ and add/update file_id to db. Import all if name not provided. Can be used for mass image update of transfer images between bots.