The purpose of this project is to Support GLAMs in monitoring and evaluating their cooperation with Wikimedia projects. Starting from a Wikimedia Commons category this tool collects data about usage, views, contributors and topology of the files inside.

Install Node.js project dependencies:

npm install

Install Python dependencies:

pip3 install -r requirements.txt

Copy the file config/config.example.json to config/config.json and modify it as required.

The provided MongoDB collection must contain documents with the following format:

{
   "name": "ETH",
   "fullname": "ETH Library of Zurich",
   "category": "Media contributed by the ETH-Bibliothek",
   "image": "https://upload.wikimedia.org/wikipedia/commons/thumb/f/f9/Aettenschwil_1953.jpg/640px-Aettenschwil_1953.jpg",
   "database": "eth",
   "http-auth": {
      "username": "eth",
      "password": "PASSWORD"
   }
}

The field http-auth is optional and may be omitted if no password is required.

Create the file .ssh/config:

Host wmflabs
   HostName      tools-dev.wmflabs.org
   User          <user>
   Port          22
   IdentityFile  ~/.ssh/<key>
   LocalForward  3306 itwiki.analytics.db.svc.eqiad.wmflabs:3306

Open the SSH tunnel to the WMF databases:

autossh -f -N wmflabs

Create a systemd service unit to auto-launch autossh (optional):

[Unit]
Description=AutoSSH for stats.wikimedia.swiss database.
 
[Service]
User=<user>
Group=<user>
ExecStart=/usr/bin/autossh -N wmflabs
 
[Install]
WantedBy=multi-user.target

Run the data gathering periodically (e.g., every 15 minutes).

cd etl
python3 run.py

To process the dates from the views chart, you can run:

cd etl
python3 run_views.py

To create the recommendation model, you need to download the Wikidata JSON dump and then run:

cd recommender
python3 model.py

To create the recommendations, you can run:

cd recommender
python3 run.py

cd app
node server