Package to use Django ORM as persistence engine in Python Telegram Bot

Home Page: https://pypi.org/project/python-telegram-bot-django-persistence/

License: MIT License

Python 100.00%

python django python-telegram-bot django-orm aiogram

python-telegram-bot-django-persistence's Introduction

python-telegram-bot-django-persistence

Do you use python-telegram-bot or aiogram with Django and want storing FSM info without additional infrastructure?
We've got you covered!

Originally, this package supported only PTB, but we added aiogram, because it is awesome!

Quickstart

📥 Install package

If you are using poetry (and if not, please, consider using it 😉):

# For python-telegram-bot
poetry add "python-telegram-bot-django-persistence[ptb]"
# For aiogram
poetry add "python-telegram-bot-django-persistence[aiogram]"

Elif you are using pip, then just enter:

pip install python-telegram-bot-django-persistence

🔌 Add the app to your Django project

Then add python_telegram_bot_django_persistence into your INSTALLED_APPS in your settings file, like so:

INSTALLED_APPS = [
    ...
    "python_telegram_bot_django_persistence",  # For python-telegram-bot
    "aiogram_djpersistence",  # For aiogram
]

☢ Migrate your database

python manage migrate

🌟 Awesome! Now use it in your bot!

python-telegram-bot

updater = Updater(bot=bot, use_context=True, persistence=DjangoPersistence())

aiogram

dp = Dispatcher(storage=DjangoStorage())

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Alexander Shishenko}
💻 📖

_{Raman Hutkovich}
💻

This project follows the all-contributors specification. Contributions of any kind welcome!

python-telegram-bot-django-persistence's People

Contributors

Stargazers

Watchers

Forkers

aleasims artrey sutiliza-org caseyy97 rhutkovich

python-telegram-bot-django-persistence's Issues

Does it work for python-telegram-bot v20.xx?

Как это должно работать?

Строки в описании:
updater = Updater(bot=bot, use_context=True, persistence=DjangoPersistence())
для понимания нубаса было недостаточно(

Объекты в джанго создаются с пустыми _namespase, а в data всегда {} - как это должно работать, может быть есть простой пример сохранения сообщений пользователя?

Adding import statement for DjangoPersistence

Bro..
Thanks for creating such an amazing application:)

Don't we need to import the DjangoPersistence class from the persistence module before adding it as an argument for the Updater object.

Value Exception on storing arbitrary callback data

I have encountered an exception when tried to use the python-telegram-bot-django-persistence library. When was initializing the ptb bot Updater class with argument persistence=DjangoPersistence(store_callback_data=True), trigger of any handler was leading to the following exception. It seems to happen when library method DjangoPersistence.update_callback_data tries to store default CDCData to the database, because according to the model.CallbackData the value must be a valid JSON.

I have tried to fix the issue by overriding the function and passing default data like defaults={'data':data}, but this introduced exception during the data fetch with get_callback_data 😢

Versions of the used libraries:

django==4.1.3
python-telegram-bot==13.14
python-telegram-bot-django-persistence==0.1.7

Example of the exception:

Package is unavailable at PyPI

$ pip install python-telegram-bot-django-persistence
ERROR: Could not find a version that satisfies the requirement python-telegram-bot-django-persistence (from versions: none)
ERROR: No matching distribution found for python-telegram-bot-django-persistence

gamepad64 / python-telegram-bot-django-persistence Goto Github PK