Wanted: A detailed but not technical jargon heavy guide to setting up a new Python webservice tool.
Should include:
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Resolved | bd808 | T171120 [FY17-18] Program 4: Technical community building | |||
| Resolved | bd808 | T166401 FY2017-18 Program 4 Outcome 1: improve documentation | |||
| Resolved | • srodlund | T177124 Improve "My first Flask OAuth tool" tutorial until it can be used as an example of a "good" tutorial | |||
| Resolved | Lea_Lacroix_WMDE | T187319 Documentation sprint @Hackathon 2018 | |||
| Declined | None | T101659 Run a documentation sprint for Cloud VPS and Toolforge | |||
| Open | None | T203131 Update and Improve Toolforge and Cloud VPS Technical Documentation | |||
| Open | None | T134494 Create a "my first Python webservice" tutorial for Toolforge | |||
| Resolved | Mridu_Bhatnagar | T177149 [Outreachy] - Improvement in Documentation. | |||
| Resolved | Slst2020 | T331724 [tbs] Create documentation on how to build and deploy a python application |
https://wikitech.wikimedia.org/wiki/Help:Tool_Labs/Python_application_stub is an example of this, but not as accessible to the general public as I'd like.
I think that @valhallasw's existing tutorial is a great start, but it's not quite as hand holding and polished as I'd like to see for the end result of the "my first ..." series. I'll try to find a bit of time to work on it to get it to the point I'd like to see.
For the record: someone just asked on IRC, who followed https://wikitech.wikimedia.org/wiki/Setting_up_Flask_cgi_app_as_a_tool and the steps are just dates back to the pmpta-era when we still used a single apache to serve webservices.
flask-mwoauth by @valhallasw has been recently updated to use mwoauth by @Halfak, and the latter even seems to have got a Flask blueprint of its own. Maybe one of them could help making the example tool simpler and more newbie-proof. Fiddling with OAuth handshakes is not something a new tool developer is likely to love...
Big kudos to @bd808 by the way.
The current tutorial does use mwoauth to do all the tricky work. It would be nice for someone to test things out with the updated flask-mwoauth blueprint. The original tutorial I started from was written by @valhallasw to showcase flask-mwoauth, but when I tried to use it it was not functional and I was unable to debug why. I'm not a flask expert by any means, but I decided that if I couldn't debug failures it would be unlikely that a beginner would be able to.
I'm a beginner at Flask and yet I was able to get flask-mwoauth to work rather easily.
Embedding login code right into app.py might turn someone into a cargo cult developer...
Have made couple of edits on https://wikitech.wikimedia.org/wiki/Help:Toolforge/My_first_Flask_OAuth_tool. And addition of screenshot for create tools.
@Mridu_Bhatnagar : Feel free to unsubscribe yourself from tickets via the Add Action... → Change Subscribers dropdown. :)