Running aiogram in neighbor container, sending messages to telegram via redis
Project description
django-redis-aiogram
django-redis-aiogram
provides a quick way to install aiogram
in a container adjacent to django
, allowing you to use your own router and loop. Also Allows you to send messages through redis
.
Supported Python and Django releases
Current release of django-redis-aiogram
is 1.0.0, and it supports Python 3.8+ and Django 4.2+.
Installation
The easiest and recommended way to install django-redis-aiogram
is from PyPI
pip install django-redis-aiogram
You need to add telegram_bot
to INSTALLED_APPS
in your projects settings.py
.
# settings.py
INSTALLED_APPS = (
...
'telegram_bot',
...
)
Also, you need to specify the minimum settings:
# settings.py
TELEGRAM_BOT = {
'REDIS_URL': REDIS_URL,
'TOKEN': TELEGRAM_BOT_TOKEN
}
Next, add a separate container to your docker-compose.yml.
# docker-compose.yml
services:
...
telegram_bot:
container_name: telegram_bot
restart: always
command: python manage.py start_tgbot
build:
context: ./
Example Usage
To send a message, use the following code:
from telegram_bot import bot
bot.send_message_via_redis(chat_id=CHAT_ID, text=TEXT)
bot.send_message_via_redis(chat_id=CHAT_ID, caption=TEXT, photo=URL)
If you need to use handlers, create file tg_router.py
(by default) in your app, use the following code:
from aiogram import types, F
from telegram_bot import bot
@bot.message(F.text.startswith('/start'))
async def start_handler(message: types.Message) -> None:
await message.answer('hi')
@bot.message()
async def simple_handler(message: types.Message) -> None:
await message.reply(message.text)
YOu can use all handler types like in aiogram.
Settings
You can override settings:
# settings.py
TELEGRAM_BOT = {
{
# event expiration time in redis
'REDIS_EXP_TIME': 5,
# redis key for handling expired event
'REDIS_EXP_KEY': 'TELEGRAM_BOT_EXP',
# redis key for collecting messages
'REDIS_MESSAGES_KEY': 'TELEGRAM_BOT_MESSAGE',
# name of the module to find
'MODULE_NAME': 'tg_router',
# telegram bot token
'TOKEN': TELEGRAM_BOT_TOKEN,
# url for redis connection
'REDIS_URL': REDIS_URL
}
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-redis-aiogram-1.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a318d8b5ee2cb465e1d4f574be8a135baf71bf72e6107c1e1e11ffbb60610ec |
|
MD5 | 7bc3953c8c696d05c6c9e1c792dd033e |
|
BLAKE2b-256 | 6ebc1167405929ec99978a522f295b3e7e060e35f961ba9817613d9e4a0ba2a2 |
Hashes for django_redis_aiogram-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d3cca8be694e55d455e5f092b5c129c8b042136d62d477285b2edd762b5390c |
|
MD5 | 0e4cb1e60ec30ecbbaf9430cec7992dc |
|
BLAKE2b-256 | 506e67e3ff044c8c982134d33927fb24ceb909e0a67e499c4f520db65c923f37 |