Differences between revisions 1 and 2
Revision 1 as of 2012-12-30 00:17:13
Size: 1638
Comment: document clutch2report.py
Revision 2 as of 2012-12-30 00:17:51
Size: 1657
Comment:
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
That is a lot of reports. The Foundation appreciates receiving the IPMC report: That is a lot of reports. The Foundation board of directors appreciates receiving the IPMC report:

Every month, approximately one third of the projects must report. It's approximate because new projects report monthly for a bit, and the number of projects is rarely zero mod three.

That is a lot of reports. The Foundation board of directors appreciates receiving the IPMC report:

  • promptly
  • in a consistent format
  • with an accurate summary of the state of the reporting podlings

To this end, there's a python program that consumes the data of the clutch and emits a report template:

Here's the usage message:

python3 clutch2report.py --help
usage: clutch2report.py [-h] [--push username password] [--month MONTH]

Create (and optionally push) a template for an incubator report.

optional arguments:
  -h, --help            show this help message and exit
  --push username password
                        whether to push the report template.
  --month MONTH         the month to report for, defaults to current month.

Early in the month, the chair will use this:

python3 clutch2report.py --push WikiUsername WikiPassword

The additional option is handy for use before the first of the month. This will replace the current contents of the relevant wiki page with the report template. Caution: it does not warn before replacing; in case of accident, use the wiki rollback feature.

If you leave off '--push' it will merely write the template into the file 'report.txt' where you can look at it.

This reads the data from clutch.pkl, so always do an 'svn up' to get the latest before using it.

ReportTools (last edited 2012-12-30 00:17:51 by BensonMargulies)