API:Client code/Evaluations/wikitools

Wikitools is a small library that facilitates interaction with the MediaWiki API. There are methods available for easily making changes to or getting information about pages, categories, users, and the wiki itself.

Particularly notable and useful aspects of wikitools include:
 * Very efficient usage of API calls
 * Packaged for Windows as well as for Fedora and through PyPI
 * The documentation that exists is clearly written and easily understandable
 * Code is usefully commented and impressively readable

= In-depth evaluation =

Easy to install
Instructions are easy to find in README. Could also include directions wih pip. Does not mention incompatibility with Python 3 (Patch/pull request submitted: https://github.com/alexz-enwp/wikitools/pull/11)
 * Installation instructions are correct and easy to find

Packaged for PyPI: https://pypi.python.org/pypi/wikitools
 * Library is packaged for installation through appropriate package library (PyPI, CPAN, npm, Maven, rubygems, etc.)

Packaged for Fedora (rpm), but not for Debian. Also packaged as a Windows .exe.
 * Platinum standard: library is packaged for and made available through Linux distributions

Easy to understand
With endpoint ( object) and parameters (appropriate  ), all calls are available. Higher-level methods are available as well (e.g. many of the methods in page.py).
 * Well designed--makes all intended API calls available with the intended level of abstraction with no redundancies

If the Wikidata endpoint is used for APIRequest and then query is called on the resulting APIRequest object, yes. For example
 * Platinum standard: makes the Wikidata API available


 * Well documented:
 * Code is commented and readable
 * Code is nicely commented and looks like Python.


 * Documentation is comprehensive, accurate, and easy to find
 * Documentation is here: https://code.google.com/p/python-wikitools/wiki/Documentation. Documentation is only linked to from . Documentation only covers the   module in depth, but is very clear and thorough for that module. Documentation appears accurate.


 * Deprecated functions are clearly marked as such
 * n/a


 * Platinum standard: Documentation is understandable by a novice programmer
 * This would be a if the documentation were more complete. The documentation that exists is easily understandable by an advanced beginner, with useful code samples in the README.


 * Code uses idioms appropriate to the language the library is written in

Easy to use

 * Has functioning, simple, and well-written code samples for common tasks
 * Demonstrates queries
 * https://code.google.com/p/python-wikitools/wiki/APIRequest#Examples and in README.


 * Demonstrates edits
 * From README:


 * Documentation specifies a slight difference in creating an  object for writing to the wiki: pass in  . There are a variety of methods for making changes to the wiki, but there is no example for using, e.g.,   to make edits directly.


 * Handles API complications or idiosyncrasies so the user doesn't have to:
 * Login/logout


 * Cookies


 * Tokens


 * Query continuations


 * Requests via https, including certificate validation
 * Will retrieve data if the endpoint begins with https, but uses  and doesn't check for certificate validity


 * Courteous API usage is promoted through code samples and smart defaults
 * gzip compression is used by default


 * Examples show how to create and use a meaningful and unique user-agent header (see https://meta.wikimedia.org/wiki/User-agent_policy)
 * Wiki.setUserAgent can be used to set a user agent, but the library/sample gives no guidance on what it should contain


 * Platinum standard: generates a unique user-agent string given name/email address/repository location
 * When logged in, the username is automatically included in the user agent. However, there is nothing comparable for a logged-out user.


 * Efficient usage of API calls
 * Nicely done. The API is called once to get information about Page and Wiki objects when they are created, and API calls are generally combined as much as possible. For example, only one combined API call is made to retrieve data on a list of pages.

Python 2 only (2.5+)
 * Can be used with the most recent stable version of the language it is written in (e.g. Python 3 compatible)

Easy to debug

 * Contains unit tests for the longest and most frequently modified functions in the library


 * Platinum standard: Unit tests for many code paths exist and are maintained

Good example here:
 * Terrible hacks/instances of extreme cleverness are clearly marked as such in comments
 * Documentation links to the relevant section/subpage of the API documentation

README links to API. The Page.edit docstring links to the associated API module documentation page.

Easy to improve
Library maintainer is not very responsive (via GitHub) as of June 2014, but existing wikitools-related comment threads are largely courteous and helpful.
 * Library maintainers are responsive and courteous, and foster a thoughtful and inclusive community of developers and users


 * Platinum standard: Project sets clear expectations for conduct for spaces where project-related interactions occur (mailing list, IRC, repository, issue tracker). It should:
 * State desired attitudes and behaviors
 * Provide examples of unwelcome and harassing behavior
 * Specify how these expectations will be enforced

Still no response on https://github.com/alexz-enwp/wikitools/pull/11.
 * Pull requests are either accepted or rejected with reason within 3 weeks (Platinum standard: 3 business days)

About half of the issues in the last year have received a response within 1 week; most of the others received no response from maintainers.
 * Issues/bugs are responded to in some manner within 3 weeks (Platinum standard: 3 business days) (but not necessarily fixed)

is still used for ; it was removed from in May 2013. No breaking changes have affected the library since then, however.
 * The library is updated and a new version is released within 3 weeks (Platinum standard: 3 business days) when breaking changes are made to the API

Contributions from Mr.Z-man include:, ,
 * Platinum standard: library maintainers contact MediaWiki API maintainers with feedback on the API's design and function

GPL 3
 * Library specifies the license it is released under

= Suggested TODOs =
 * Add directions to install with  to the README
 * Mention incompatibility of the current library with Python 3 in README: https://github.com/alexz-enwp/wikitools/pull/11
 * Expand the documentation to modules besides, including links to the relevant API subpages
 * Remove use of  when using
 * Add to the code samples:
 * an example of using  to make edits
 * usage of
 * Use the  parameter instead of   to handle query continuations
 * For security and clarity, use  instead of   to handle http requests
 * Add compatibility with Python 3
 * Add unit tests for the longest and most frequently modified functions
 * Decide and communicate the intended level of responsiveness (either enabling a faster response to comments/pull requests/issues, or noting the maintenance/development status in the README). If you are interested in wikitools being listed as a gold standard library, active maintenance and prompt responses are important--even if a given issue is too big to fix immediately or a patch too complex to review quickly.

If these issues are addressed, wikitools will meet the gold standard and will be listed as such on API:Client code.