temple-attendance-tracker

Installation

To run this, you will need:

• Python 3.6 or above
• Git, in order to git clone the repository
• A few python packages: requests, gspread, pandas

Installing python

If you are not sure if you have python installed, you can check by opening a terminal window (use cmd.exe or powershell in Windows) and run

python --version

If you get an error, you need to install python.

It is probably easiest to go to the website and install it from there: https://www.python.org/downloads/

Once install has completed, check it is working properly:

python --version

Installing required packages

Installing the required python packages should be pretty simple with pip.

pip install requests
pip install pandas
pip install gspread

Installing git

This is needed to not only clone the repository to begin with, but will also allow you to keep up to date with any future changes.

If you are on Windows and not a developer, there is a good chance Git is not installed. However, you can still check with:

git --help

This is another tool that is probably best downloaded from the website: https://git-scm.com/downloads Git doesn't seem to work well in Powershell without a special package posh-git, at least for me, but I've had success with running this and successive steps on cmd.exe. Once installed, check that the command works with git --help.

Cloning the Repo

Navigate to the place where you'd like to download and run the script from, and run

git clone [url]

Subsequently, if you ever need to update the script from its source, you can navigate into the temple-attendance-tracker folder and just run

git pull

Credentials

Warcraft Logs

Sign in to Warcraft Logs. Click your profile icon in the upper right, then click Settings at the bottom of the menu. On the settings page, scroll down to the bottom and there should be an API section. Copy the v1 API key and paste it into your config json file as the value for the "wcl_api_key" key.

Google Sheets

Unfortunately, the script had to be registered to google in "testing phase" and so the credentials will expire after one week and will need to be regenerated.

Go to https://console.cloud.google.com/welcome?project=temple-raid-attendance-v1 and click on "APIs and Services" under Quick Access. In the menu on the left-hand side, click "Credentials", then click on "+ Create Credentials" in the bar above the main content. In the options that pop up, select OAuth Client ID. In the next window, for Application Type select "Desktop app". For Name, I always call it "Desktop client 1" but i don't think it really matters. When you press create, a pop-up will show with the new credentials. Don't X out of this immediately, but click the download icon to save a json file. Save the file to C:%APPDATA%\gspread\credentials.json.

To test that the credentials are working, open up a python interpreter in your terminal window by running

python

And then run the following commands to authorize your credentials and make sure they are working:

import gspread
gc = gspread.oauth()
sh = gc.open("Temple Attendance Sheet (Test)")

Regenerating Google Credentials

After 7 days, your google credentials will expire. When this happens, first go to C:%APPDATA%\gspread\credentials.json and delete the authorized_user file. You can then follow the steps above to create new credentials and save them to the same location.

Running the Script

It should be possible to run this script on either guild-logged raids, or individually logged raids that aren't associated with the guild. For guild-logged raids, the script can be run to update one day of raiding. For raids not logged to the guild, it can be run to add one raid at a time.

Updating the raid attendance should generally follow 3 steps:

1. Updating the config file
2. Updating the alts file
3. Running the script

Updating the config file

The repo comes with a file that is best used as an example and should be preserved as it is. Instead, create a copy of this file and name it config.json or whatever you prefer. In the credentials section above, we talked about how to get the warcraftlog API key and add it to the config. This value should be static every time the script is run and should not need to be updated.

Everytime the script is run, you will however need to update the other values.

Attendance file name

Use "Temple Attendance Script (Test)" if you are still testing or trying out the script; use "Temple Attendance Script (New)" if you are confident everything is working.

Guild reports

Set to true (without quotes) if the report(s) is logged to the guild, false if logged to a user's personal account.

Guild report IDs

This is a list of report IDs logged to the guild on the same day.

Non guild report ID

This should only be populated when using a report not associated with the guild. Can only do one at a time.

Non guild user

This is the Warcraftlogs User name of the person who uploaded the report.

Non guild raid name

This is the name of the raid that the non-guild report is for. Acceptable values are "Naxx", "AQ40", "BWL", and "MC".