Evaluating MediaWiki web API client libraries

This is a placeholder for Frances Hocutt's |Evaluating MediaWiki Web API Client Libraries project.

Evaluating MediaWiki web API client libraries

 * Public URL: https://www.mediawiki.org/wiki/Evaluating_MediaWiki_web_API_client_libraries
 * Bugzilla report: (link to the related report at http://bugzilla.wikimedia.org )
 * Announcement: http://article.gmane.org/gmane.science.linguistics.wikipedia.technical/76046

Name and contact information

 * Name: Frances Hocutt
 * Email: franceshocutt@gmail.com
 * IRC or IM networks/handle(s): fhocutt
 * Web Page / Blog / Microblog / Portfolio: http://franceshocutt.com / http://twitter.com/franceshocutt
 * Resume (optional): http://franceshocutt.com/cv/
 * Location: Seattle, WA, USA
 * Typical working hours: between 1 pm and 2 am PDT (can move earlier if more convenient)

Synopsis
(short summary)

What it means to accomplish: search through the available API client libraries in Python, Perl, Ruby, JavaScript, and Java and find the gems. Make a path to polish the gems and evaluate them to test their capabilities. Finally, pick one to polish up myself.

How it will benefit MediaWiki or Wikimedia projects: it'll make it easier to write bots to interact with the API; it'll make the existing [].


 * Possible mentors: Sumana Harihareswara, Co-mentor Tollef Fog Heen, Technical Advisers Merlijn van Deen and Brad Jorsch.

Deliverables
Please describe the details and the timeline of the work you plan to accomplish on the project you are most interested in (discuss these first with the mentor of the project):

In general: find the MediaWiki API client libraries available in those 5 languages. Evaluate them on functionality, up-to-date-ness, usability, presence/quality of documentation, level of abstraction, and any other relevant criteria, and pick the best one(s). Document, document, document (my testing) and submit helpful things to the libraries.

Once I'm done with that, choose a project to make more in-depth contributions to: bug reports, bugfixes, and improved documentation.

1 day for best in lang

I think the "helpful things" you submit to the libraries will include documentation of your testing, yes (your lab notebook), and praise for where they get things right, and better documentation for them if you happen to write it along the way while evaluating, and bug reports for things they need to improve "choose a project to make more in-depth contributions to: bug reports, bugfixes, and improved documentation. Especially improved documentation." I would actually put the emphasis on the bugfixes personally

Participation
I plan to publish my weekly status updates on User:fhocutt, including links to any place outside of MediaWiki where I have contributed code or documentation (i.e. the repositories for the various client libraries). I will also stay in contact with my mentor through regular videochats and over IRC. I plan to publish my in-progress work on the project page (or sub-pages). I plan to ask for help on IRC, wikitech-l, or personal chat/email with my mentors.

About you

 * Education completed or in progress:


 * University of Washington, MS, Chemistry, 2012–June 2014 (planned graduation date).
 * University of Washington, MS, Materials Science and Engineering, 2010–2012.
 * Harvey Mudd College, BS with distinction, Chemistry, 2003–2007.


 * How did you hear about this program?

I first heard about the OPW through Twitter—@callbackwomen, @ashedryden, and @hypatiadotca all promoted it. I didn't think that the program would be a good fit for me until Sumana Harihareswara reached out to me with encouragement and a few project suggestions. I realized that evaluating and contributing to API client libraries would be a good fit for my skills and goals, and I was excited to get the chance to work with Sumana.


 * Will you have any other time commitments, such as school work, another job, planned vacation, etc., during the duration of the program?

I will be attending OSBridge June 24–27 and volunteering there. I will definitely be traveling June 19–22; I may leave as early as June 15.


 * We advise all candidates eligible to Google Summer of Code and FOSS Outreach Program for Women to apply for both programs. Are you planning to apply to both programs and, if so, with what organization(s)?

I will not be enrolled during the Spring 2014 quarter, so I will not be eligible for Google Summer of Code.

I am passionate about tools and I define "tools" broadly. No matter what discipline, I usually find myself making tools, sharing them, making them better, and teaching other people how to use them.
 * Why I want to make this project happen:

As a chemist, I developed a new reaction—a new tool for forming chemical bonds—optimized the reaction conditions, and tested it with a range of chemical inputs to find what types of chemicals would lead to high yields of product and what types would lead to none. As a handspinner, I've started modeling the mechanical relationships that let my spinning wheel vary the twist and tension on the forming thread. As a hackerspace organizer, I notice where tools for communication and collaboration can fit into our workflow, and along with the other members I try to find what works best for us.

The MediaWiki platform is another tool. Wikis enable collaboration, easy sharing of information, and user-built databases that have the potential to continually improve through the small contributions of many. By improving the MediaWiki API client libraries, I would make it easier to users and maintainers to access these wikis and use the data in them for their own purposes. By evaluating the libraries and selecting the best, I would inform potential users which of these tools are the most effective and the easiest to use. As I completed my evaluation I would offer a clear roadmap for improvement. In the final portion of this project I would improve one of these libraries with bugfixes and more documentation. I would, finally, make one of these tools as easy and effective to use as I could.

Past experience

 * Please describe your experience with any other FOSS projects as a user and as a contributor:

I've been using free/open source software for nearly a decade now. All of my computers run Ubuntu, which makes it easy to install and use other open source programs. I use Audacity for audio processing, Inkscape for image creation and manipulation, VLC for media, Chromium as a web browser, and more. In my academic work, I used LaTeX and its open source editors for document management and creation, and I ported existing Matlab scripts to Python so that I could expand on them to model the dynamics of a system I was studying. Like many students, I used Wikipedia as a jumping-off point for further research, and eventually I started making my own contributions (mostly anonymously). I've used LiveJournal and Dreamwidth for online journaling platforms for years now. I've recently started contributing to Dreamwidth as a developer, and to do so I've been learning Perl, vi, and git.


 * Please describe any relevant projects that you have worked on previously and what knowledge you gained from working on them (include links):

I have recently started development work for the Dreamwidth journaling platform. I checked out my first bug recently, and will submit a patch soon. When I'm more familiar with the codebase I plan to contribute to Dreamwidth's ongoing and extensive project of converting sections of the codebase from a custom markup language to Template Toolkit.
 * Dreamwidth

Last May, a small group of us started the Seattle Attic, the first hacker/makerspace explicitly founded on feminist principles. This project is not explicitly F/OSS related (although it has already fostered in-person collaboration) but it is a space founded on open culture. I wrote our code of conduct, our bylaws, and our statement of values. All of these are essentially documentation for our in-person community. These involved persuasively describing expected behavior; taking what I needed from a variety of sources and creating a coherent and consistent whole; and incorporating community feedback to write a statement of values that we all agreed was accurate. I would draw on these skills when approaching standards, TODOs, and documentation.
 * Seattle Attic Community Workshop

Link to microtask.
 * MediaWiki


 * What project(s) are you interested in (these can be in the same or different organizations)?

I am most interested in the Evaluating MediaWiki web API client libraries project with the Wikimedia Foundation.