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.5, 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 = {
# ------------ REQUIRED ------------
'REDIS_URL': REDIS_URL,
'TOKEN': TELEGRAM_BOT_TOKEN,
# ------------ OPTIONAL ------------
# 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',
# default kwargs for telegram bot
'DEFAULT_KWARGS': lambda aiogram_function: {}
}
Next, add a separate container to your docker-compose.yml. (optional, if you want to use routers and handlers)
# 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:
# test.py
from aiogram import types, F
from telegram_bot import bot
# sending a message directly
bot.send_raw(chat_id=CHAT_ID, text=TEXT)
bot.send_raw('send_photo', chat_id=CHAT_ID, caption=TEXT, photo=URL)
# sending a message via redis
bot.send_redis(chat_id=CHAT_ID, text=TEXT)
bot.send_redis('send_photo', chat_id=CHAT_ID, caption=TEXT, photo=URL)
# markup example
markup = types.InlineKeyboardMarkup(inline_keyboard=[
[types.InlineKeyboardButton(
text='best project ever',
web_app=types.WebAppInfo(url='https://pypi.org/project/django-redis-aiogram')
)]
])
bot.send_raw(chat_id=CHAT_ID, text=TEXT, reply_markup=markup)
bot.send_redis(chat_id=CHAT_ID, text=TEXT, reply_markup=markup)
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
def default_kwargs(function: str) -> dict[str, Any]:
"""Default kwargs for telegram bot functions."""
prepared_dict = {
'send_message': {'parse_mode': 'HTML'},
'send_photo': {'parse_mode': 'Markdown', 'caption': '`Photo`'}
}
return prepared_dict.get(function, {})
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',
# default kwargs for telegram bot
'DEFAULT_KWARGS': default_kwargs,
# 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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b86634ceaa5637680fe114e666189fc1302d6b9f7f04fa80f0a40ee56c7d31ba |
|
MD5 | a3a9ced5a04d211c0c280667d398cb5a |
|
BLAKE2b-256 | 371511a04b8c9b613a2f3597401b78560837ca2ea40664cf0d01acd042272781 |
Hashes for django_redis_aiogram-1.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 21653cbdf6f1664c7dd588eddf7f0fd8988c8f70c430822f637689c54d63763a |
|
MD5 | e0fe158b4699000d0bc6852c8a77a3ab |
|
BLAKE2b-256 | 5300ed0b80065c8ee5defa1a2de62078e438ad47283cff89ca934cd1391715ec |