Africa Wikimedia Developer (AWMD) statisitics tool is meant for gathering monthly statistics of African technical contributors into Wikimedia projects such as; MediaWiki, MediaWiki extensions, etc. For more information see: https://www.mediawiki.org/wiki/Awmd-stats
The tool uses a method to rank different contributors based on their patches and the state of the patch. Assume "m" is the number of patches merged and "n" is the number of patches under review, the formula is:
points = (2 x m) + n
git clone ssh://<USERNAME>@gerrit.wikimedia.org:29418/labs/tools/awmd-stats
Install application dependencies and regenerate documentation using the setup.sh
script:
./setup.sh
The above script attempts to check system requirements and tell informs user on next steps.
export FLASK_APP=flasky.py
flask run
To view documentation of the codes which makes use of the docstrings, use this endpoint
localhost:5000/docs/index
https://tools.wmflabs.org/awmd-stats/docs/index
pip install pytest
Then run the command below (make sure you're in the project's root for example):
py.test -v tests/
NOTE
: If you find any failing test, report on Phabricator here: https://phabricator.wikimedia.org/project/board/2858/.
The contributors to this tool are strongly encouraged to use the following coding guidelines:
- You want your contributions to be tracked by this tool? Nicely add your information in the
contributors.json
in theJSON
format and the tool will automatically run a cron to fetch your contributions.
- Samuel Guébo - Project Lead
- Derick Alangi - Contributor
This project is open source and available under the MIT License.