The generate_summary script generates CTF summary based on google spreadsheet that contains information about who solved which CTF tasks.
We use it in JHTC in order to send emails with CTF results/summary along with some "What we learned" info.
It has been written for Python 3. However it might work with Python 2.
Pure words won't describe everything as soon as examples, so let's assume we have such a spreadsheet:
Here we generate the summary:
$ python summary_generator.py 1aXcW2gEQIZHtjnN2EJMG73Z8Z6Do9VBqfxVKlWAnez2
Zdobyte punkty - 500:
- Gros: 300
crypto - Banh cuon: 200
crypto - Bun cha: 100
- k4Mr3: 200
web - Banh can: 100
web - Banh bot loc: 100The 1aXcW2gEQIZHtjnN2EJMG73Z8Z6Do9VBqfxVKlWAnez2 is a spreadsheet key, which can be found in the link to your spreadsheet (e.g. https://docs.google.com/spreadsheets/d/1aXcW2gEQIZHtjnN2EJMG73Z8Z6Do9VBqfxVKlWAnez2/edit#gid=0).
This of course requires some authentication. In order to make it work, you must create a "service account" within google spreadsheets api. All of this is already described in gspread documentation.
After having the .json service key file, just put it in ./ccredentials/googlesheet_key.json.
The last thing you have to do is to make the google spreadsheet service account able to read particular spreadsheets. In the json key file, there is a client_email. Just share your spreadsheets to this e-mail address and the job's done.
- the header row must be the second row (summary_generator.py#L42 -
head=2argument) - it fetches the data using header names, which can be changed in summary_generator.py#L27-L31
The requirements/dependencies can be found in requirements.txt. You can install them using pip Python packages manager:
pip install -r requirements.txt
To launch the script, see What does it do?.
Just create an issue or/and help us with coding and make a Pull Request!
The script has been made by disconnect3d from Just Hit The Core CTF team.