akashagarwal created this task. akashagarwal claimed this task. akashagarwal added subscribers: akashagarwal, happy5214, Legoktm, gerritbot, rmoen, EBernhardson, NiharikaKohli, Capt_Swing, Qgil, jayvdb, Mattflaschen, Xqt, Ricordisamoa, Multichill, Ladsgroup, pywikipedia-bugs. akashagarwal added projects: Google-Summer-of-Code-2015, Collaboration-Team, Possible-Tech-Projects, Flow, pywikibot-core, Pywikibot-General. Restricted Application added a subscriber: Aklapper. TASK DESCRIPTION ==Profile Information== - Name: Akash Agarwal - Email: akashslg(a)gmail.com - IRC nickname: akashagarwal - Github : https://github.com/akashagarwal/ - Resume : https://dl.dropboxusercontent.com/u/94374390/AkashAgarwal.pdf - Location: Hyderabad, India (Time Zone - UTC+05:30) - Typical working hours: 6:00 - 14:00 UTC & 17:00 - 21:00 UTC ==Synopsis== Pywikibot is a collection of tools that allows one to automate work on a MediaWiki site. As per [[ http://stats.wikimedia.org/EN/BotActivityMatrixEdits.htm | Wikimedia stats ]] 910 M or 25.8 % of total edits are made by bots. So, Pywikibot is one the major projects for Wikimedia Foundation which makes consuming the MediaWiki API simple for bot developers. Flow, the new communication extension for MediaWiki is not supported by Pywikibot. When the Flow extension is installed and Flow is enabled on a page (usually a Talk page - [[ https://en.wikipedia.org/wiki/Wikipedia_talk:WikiProject_Breakfast | example ]]), the page becomes a Flow board (the content model property changes to 'flow-board' instead of 'wikitext'). The content in such a page is quite different from a general wiki page (For example, Flow stores a revision per post not per article and flow data can be on a different database. Also, several wikis may use the same database for flow ). As a result, the API calls for a general wiki page will not work for Flow enables pages. Flow has an extensive set of API’s which needs to be implemented in Pywikibot. Possible mentors : @jayvdb, @Mattflaschen, @Legoktm ==Deliverables== As per T67119 the main goal of this project will be to implement the concepts of Flow as Pywikibot classes and adding unit tests to interact with test Flow pages. The code written as part of the project can be categories as: ==Part 1: Adding flow functionality in Pywikibot == This will be done by inheriting from the pywikibot base class BasePage. The main functionlities will be added in page.py or in a new flow.py. === Basic Flow information === Add the API Action = query,prop = flowinfo in Pywikibot which should give the basic flow information about a page. Already implemented ( https://gerrit.wikimedia.org/r/#/c/132767/) but we may need to modify and/or add unit tests. Also, it may be needed to update prop = info in Pywikibot. === Flow API === These include the read and write API consisting of submodules of action=flow. GET - Read API’s - view-topiclist ( ApiFlowViewTopicList ) - example - http://en.wikipedia.org/w/api.php?action=flow&submodule=view-topiclist&… - view-post ( ApiFlowViewPost ) - view-topic ( ApiFlowViewTopic ) - view-header ( ApiFlowViewHeader ) - view-topic-summary ( ApiFlowViewTopicSummary ) POST - Write API’s - new-topic ( ApiFlowNewTopic ) - edit-header ( ApiFlowEditHeader ) - edit-post ( ApiFlowEditPost ) - edit-topic-summary ( ApiFlowEditTopicSummary ) - reply ( ApiFlowReply ) - moderate-post ( ApiFlowModeratePost ) - moderate-topic ( ApiFlowModerateTopic ) - edit-title ( ApiFlowEditTitle ) - lock-topic ( ApiFlowLockTopic ) - close-open-topic ( ApiFlowLockTopic ) Legoktm has added some related code at https://gerrit.wikimedia.org/r/#/c/187066/3 which may or may not be helpful. === Flow parsoid utility === Since, we have the Parsiod web API ( https://www.mediawiki.org/wiki/Parsoid/API ), I am not sure whether it would be relavent the add support for the action=flow-parsoid-utils API, which converts text between wikitext and HTML,in Pywikibot. == Part 2: Unit tests == As specified in T67119 , unit tests will be added to the test suite to interact with test Flow pages on a Flow enabled Wikimedia site (e.g. MediaWiki.org). The tests will interact with Flow objects using the Flow specific functionality, and interact with the same pages using the standard Page functionality where appropriate. The unit tests will be configured to run on travis-ci , and Flow related tests run when the test site has Flow enabled, and Flow related tests will be skipped when Flow isn’t installed. == Part 3: Server version tracking (optional) == As Flow is being rapidly developed, we can expect changes in functionalities and different wikis may have several different versions of the Flow extension installed. It is important for Pywikibot to support them. If time permits, the Flow support will include server version tracking, so Flow features can easily be enabled/disabled as the Flow extension is enhanced. ==Timeline== | 27 April | Accepted student proposals will be announced | | 27 April - 25 May | Community bonding period. Get familiar with the Flow and Pywikibot developer community. Finalize plans for the project and go through the code base, read documentation. | | 25 May | Coding period begins | | 25 May - 3 July | Part 1: Adding flow functionality in Pywikibot | | 3 July | Mid-term evaluations due | | 3 July - 20 July | Part 2: Unit tests | | 20 July - 14 August | Reiterate based on feedback, solve bugs, Part 3: Server version tracking (optional) | | 14 August - 21 August | Documentation, Solve Bugs | | 21 August | Pencils down data | | 28th August | Final Evaluations due | ==Past experience== MediaWiki extension on Peer Evaluation - https://github.com/akashagarwal/peer-evaluation ==Microtasks== https://gerrit.wikimedia.org/r/#/c/196450/ (T72965 and T85725) TASK DETAIL https://phabricator.wikimedia.org/T94131 REPLY HANDLER ACTIONS Reply to comment or attach files, or !close, !claim, !unsubscribe or !assign <username>. EMAIL PREFERENCES https://phabricator.wikimedia.org/settings/panel/emailpreferences/ To: akashagarwal Cc: pywikipedia-bugs, Ladsgroup, Multichill, Ricordisamoa, Xqt, Mattflaschen, jayvdb, Qgil, Capt_Swing, NiharikaKohli, EBernhardson, rmoen, gerritbot, Legoktm, happy5214, Aklapper, akashagarwal, Imaculate, matthiasmullie, Gryllida, Spage, Quiddity