Self Evaluation - Revision history

Wf at 23:52, 5 January 2015

2015-01-05T23:52:11Z

Wf at 23:51, 5 January 2015

2015-01-05T23:51:25Z

Wf: /* Easy to install */

2015-01-05T23:41:58Z

Easy to install

Wf: /* Easy to install */

2015-01-05T23:37:43Z

Easy to install

Wf: Created page with "[https://github.com/eldur/jwbf Java Wiki Bot Framework] is a Java framework, intended to make it easy to write Java bots that interact with the MediaWiki API. It handles login..."

2015-01-05T11:48:35Z

Created page with "[https://github.com/eldur/jwbf Java Wiki Bot Framework] is a Java framework, intended to make it easy to write Java bots that interact with the MediaWiki API. It handles login..."

New page

[https://github.com/eldur/jwbf Java Wiki Bot Framework] is a Java framework, intended to make it easy to write Java bots that interact with the MediaWiki API. It handles login/logout, cookies, query continuations, and tokens, and has a range of helper methods for common tasks as well as for basic interaction with the MediaWiki API.

Particularly notable or useful features of JWBF include:
* Designed and implemented as framework for writing bots
* Solid codebase and a good set of features
* Has frequently updated unit and integration tests
* A responsive and helpful maintainer

==Easy to install==
;Installation instructions are correct and easy to find
{{Cross}} No installation instructions.

;Library is packaged for installation through appropriate package library (PyPI, CPAN, npm, Maven, rubygems, etc.)
{{Green check}} [http://search.maven.org/#artifactdetails|com.bitplan|mediawiki-japi|{{Version}}|jar Maven Central]

;''Platinum standard: library is packaged for and made available through Linux distributions''
{{Cross}} It is unusual to ship Java packages with Linux distributions.

==Easy to understand==
;Well designed--makes all intended API calls available with the intended level of abstraction with no redundancies
{{Green check}} Stays 1:1 to message Schema. Each node is represented with the appropriate Java equivalent e.g. Api/Query/Error ...

;''Platinum standard: makes the Wikidata API available''
{{Cross}}

;Well documented:
* Code is commented and readable
: {{Green check}}
* Documentation is comprehensive, accurate, and easy to find
:{{Green check}} Wiki page with example per function.
* Deprecated functions are clearly marked as such
:{{Yellow check}}
* ''Platinum standard: Documentation is understandable by a novice programmer''
:{{Yellow check}} tutorial planned
; Code uses idioms appropriate to the language the library is written in
{{Green check}} Adequately written Java.

==Easy to use==
; Has functioning, simple, and well-written code samples for common tasks
* Demonstrates queries
:{{Green check}}
* Demonstrates edits
:{{Yellow check}}
;Handles API complications or idiosyncrasies so the user doesn't have to:
*Login/logout
:{{Green check}}
*Cookies
:{{Green check}}
*Tokens
:{{Green check}}
*Query continuations
:{{Yellow check}} Need to use the new <code>continue</code> parameter for newer versions of the API.
*Requests via https, including certificate validation
: {{Yellow check}} Need issue.
;Courteous API usage is promoted through code samples and smart defaults
*gzip compression is used by default
: {{Yellow check}} See tests (<code>HttpBotTest</code> and <code>HttpActionClientTest</code>) that proves that gzip is the default of jwbf for what needs to be done.
*Examples show how to create and use a meaningful and unique user-agent header (as in https://meta.wikimedia.org/wiki/User-agent_policy)
:{{Yellow check}}
*''Platinum standard: generates a unique user-agent string given name/email address/repository location''
: {{Yellow check}} see - user-agent header is provided but not configurable and documented yet
*Efficient usage of API calls
:{{Yellow check}} needs to be worked on
;Can be used with the most recent stable version of the language it is written in (e.g. Python 3 compatible)
{{Green check}}

==Easy to debug==
; Contains unit tests for the longest and most frequently modified functions in the library
{{Yellow check}}
; ''Platinum standard: Unit tests for many code paths exist and are maintained''
{{Yellow check}} The framework has integration tests as well.
; Terrible hacks/instances of extreme cleverness are clearly marked as such in comments
{{Green check}} Comments include FIXMEs
; Documentation links to the relevant section/subpage of [[API|the API documentation]]
{{Green check}} Consistently - examples are organized as the API documentation is

==Easy to improve==
; Library maintainers are responsive and courteous, and foster a thoughtful and inclusive community of developers and users
{{Green check}} Maintainer is actively involved and helpful.
;''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''
{{Yellow check}}
; Pull requests are either accepted or rejected with reason within 3 weeks ''(Platinum standard: 3 business days)''
none submitted
; Issues/bugs are responded to in some manner within 3 weeks ''(Platinum standard: 3 business days)'' (but not necessarily fixed)
{{Yellow check}} There is usually a response within 1 week.
; 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
n/a
; ''Platinum standard: library maintainers contact MediaWiki API maintainers with feedback on the API's design and function''
{{Yellow check}} contact attempts done e.g. with MER-C
; Library specifies the license it is released under
{{Green check}} Apache 2.0

=Suggested TODOs=
;Code-related:

;Process-related:

The gold standard needs to be met to be listed on [[API:Client code]].

← Older revision		Revision as of 23:51, 5 January 2015
Line 1:		Line 1:
−	[https://github.com/~~eldur~~/~~jwbf Java Wiki Bot Framework~~] is a Java framework, intended to make it easy to write Java bots that interact with the MediaWiki API. It handles login/logout, cookies, query continuations, and tokens, and has a range of helper methods for common tasks as well as for basic interaction with the MediaWiki API.	+	[https://github.com/WolfgangFahl/Mediawiki-Japi Mediawiki-Japi] is a Java framework, intended to make it easy to write Java bots that interact with the MediaWiki API.
		+	It handles
		+	* login/logout
		+	* cookies
		+	* query continuations {{Cross}}
		+	* and tokens,
		+	and has a range of helper methods for common tasks as well as for basic interaction with the MediaWiki API. {{Cross}}

	Particularly notable or useful features of JWBF include:		Particularly notable or useful features of JWBF include:

@@ Line 7: / Line 7: @@
 and has a range of helper methods for common tasks as well as for basic interaction with the MediaWiki API. {{Cross}}
-Particularly notable or useful features of JWBF include:
+Particularly notable or useful features of Mediawiki-Japi include:
-* Designed and implemented as framework for writing bots
+* Designed and implemented on the basis of the API schema
 * Solid codebase and a good set of features
 * Has frequently updated unit and integration tests
@@ Line 15: / Line 15: @@
 ==Easy to install==
 ;Installation instructions are correct and easy to find
-{{Green check}} No installation instructions.
+{{Green check}}
 ;Library is packaged for installation through appropriate package library (PyPI, CPAN, npm, Maven, rubygems, etc.)

@@ Line 12: / Line 12: @@
 ;Library is packaged for installation through appropriate package library (PyPI, CPAN, npm, Maven, rubygems, etc.)
-{{Green check}} [http://search.maven.org/#artifactdetails|com.bitplan|mediawiki-japi|{{Version}}|jar Maven Central]
+{{Green check}} [http://search.maven.org/#artifactdetails|com.bitplan|mediawiki-japi|{{currentVersion}}|jar Maven Central]
 ;''Platinum standard: library is packaged for and made available through Linux distributions''