Documentation on the flask section

[joshy]

Hi, thanks for the great library as I think it hits a sweet spot for just delivering enough to authenticate against Entra ID in my case. This is just a suggestion on adding information on the flask section.

As I am using flask the natural choice was using identity with flask. I followed the doc but on the sign-in page it was asking for entering some code on the next page. I felt this was strange. This was because I left out redirect_uri because I didn't know what to put in there. Maybe a small comment that leaving it out would trigger the device code authentication. As it is not possible to use url_for without a request context it is also necessary to provide the full redirect url. For example dev setup would it be http://localhost:5000/getAToken and in prod something like https://server.com/getAToken.

Best regards,
Joshy

[rayluo]

Fair point. I'll see what I can do. Meanwhile, here come some brief information.

1. The existing documentation shows a snippet of setting the redirect_uri, because it is conceptually required. Its value is determined by your application's registration in your Identity Provider. Detail steps are in the first row of this table in README.
2. The absence of redirect_uri will typically result in an error in most other auth library. But this identity library has an experimental feature of supporting its absence. Did it not work for you? In any case, consider it as an easter egg. :-)

[rayluo]

It is tricky to add too much information into the short sample, so, only a couple lines of inline comments are added into the short code snippet here, and one of them will lead you to this refined README table (pay attention to the new second row). What do you think?

Currently, the new links above are for proofreading. I plan to merge them in soon.

[joshy]

Looks great. One small suggestion: Here would you consider putting the comment on top each line? Maybe you need to check out how it looks because I am not sure how many people are scrolling to the right. I like the example section in the README.

[rayluo]

Fair point. I managed to still use an inline comment to make sure the redirect_uri explanation is on-the-spot, while avoiding long lines. How does the updated docs look now?

[joshy]

Do you think putting one example url makes sense? Like http://localhost:5000/redirect or https://your_website.com/redirect. Otherwise looks great. Thanks for making chose changes.

[rayluo]

Good suggestion! The doc staging site has been updated again. What do you think? :-)

[joshy]

Ready to merge 🤘🏾