INSTALLING.md

Installing locator-tool

$ git clone https://github.com/simon04/locator-tool.git $HOME/locator-tool
$ mkdir -p $HOME/www/python

$ cd $HOME/www/python
$ ln -s $HOME/locator-tool/backend src
$ virtualenv venv
$ source venv/bin/activate

$ cd $HOME/www/python/src/
$ git clone --branch=gh-pages https://github.com/simon04/locator-tool.git static
$ pip install -r requirements.txt
$ cp config-example.py config.py
# generate random string for SECRET_KEY
# for OAUTH_CONSUMER_KEY and OAUTH_CONSUMER_SECRET see below

# specific to locator-tool.toolforge.org, see https://github.com/wikimedia/operations-software-tools-webservice/blob/master/toollabs/webservice/services/pythonwebservice.py
$ webservice --backend=kubernetes python start

Register OAuth client

Register tool at https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration/propose with "OAuth callback URL" = https://locator-tool.toolforge.org/oauth-callback and "Edit existing pages" grant. Insert the displayed strings as OAUTH_CONSUMER_KEY and OAUTH_CONSUMER_SECRET into the config.ini file.

Further information

For more details, see:

• https://wikitech.wikimedia.org/wiki/Help:Tool_Labs/Python_application_stub
• https://www.mediawiki.org/wiki/Extension:OAuth
• https://www.github.com/valhallasw/flask-mwoauth