Provide Versions of customwebhookbot.py with Different Frameworks

[Bibo-Joshi]

Closes #3717 by providing versions with flask, quart and Django. Other examples can ofc be added later as well.

I have used neither of the frameworks before, so the examples are surely not optimal from their perspective and I'm happy for improving comments. Especially for Django I am sure that an actual Django project would set this up very differently as (AFAIK) Django usually makes heavy use of several modules & files.

Moreover, I want to point out that ASGI servers like uvicorn are more frequently started from the command line than from within a python script, but I kept to this scheme because

1. that way we don't have to provide additional info on how to run the script (it's just python script.py as per usual)
2. I would have to figure out how to start & stop the ptb application properly in such a setup …

Docs build it available here.

[lemontree210]

This looks so great! We're becoming incredibly developer-friendly 😆
I am only suggesting some changes to the comments and, while we're at it, docstrings.

[lemontree210]

Yes, a full-fledged Django project would have its own configuration files. This is an interesting question: on the one hand, we have to provide a short example, and that's why we're using django.conf.settings, as per Django docs. On the other hand, though, the reason we are providing examples for other frameworks should be that the user already uses one of them in their code and hence, in case of Django, has all these settings in separate files. This might mean that, for a user that doesn't care which app to use for routing of requests, any framework will do, but a user that already uses Django might not find the Django example useful. Then, instead of one example with some lines changed for the respective framework, this actually should expand into something of a tutorial (if you're using Django, but add these lines to urlpatterns, then add this to your settings file etc.). Which, in turn, sort of subverts the idea of having a simple usage example.

[Bibo-Joshi]

This might mean that, for a user that doesn't care which app to use for routing of requests, any framework will do, but a user that already uses Django might not find the Django example useful.

This is a very valid argument, but at least for now I would give more weight to your last point

Which, in turn, sort of subverts the idea of having a simple usage example.

I think whenever two frameworks are being used together one will have to find a midway of usability and best practice. This is a first step in this direction. Maybe we can just include a disclaimer, maybe something along the lines

The following examples show how different Python web frameworks can be used alongside with PTB. This can be useful for two use cases:

1. For extending the functionality of your existing bot to handling updates of external services
2. For extending the functionality of your exisiting web application to also include chat bot functionality

How the PTB and web framework components of the examples below are viewed surely depends on which use case one has in mind. We are fully aware that a combinations of PTB with web frameworks will always mean finding a trade off between usability and best practices for both PTB and the web framework and these examples are certainly far from optimal solutions. Please understand them as starting points and use your expertice of the web framework of your choosing to build up on them. You are of course also very welcome to help improve these examples!

?

[lemontree210]

I think whenever two frameworks are being used together one will have to find a midway of usability and best practice. This is a first step in this direction. Maybe we can just include a disclaimer, maybe something along the lines:

Great disclaimer, agreed :)

[lemontree210]

Great, just a couple of typos in the disclaimer :)

[harshil21]

Wow, didn't realize how similar these examples would be! Unfortuantely I can't setup a webhook right now so can't run these examples. I assume you tested all of them? I also like the inline tabs idea, that's neat

Review comments below are mostly stylistic/design based.

[harshil21]

I assume you tested all of them?

?

[Bibo-Joshi]

@harshil21 Yes