search

ieb / timetables

Timetables
http://www.caret.cam.ac.uk/blogs/ucam-timetables/
GNU Affero General Public License v3.0
2 stars 1 forks source link

Rationalise the Generator Scripts #1

Closed ieb closed 12 years ago

ieb commented 12 years ago

At present we have a set of generator scripts that take a mixture of csv files from source through to json files. Although they work, driving them is a black art. I think we need to do two things.

  1. Fully document how they work, what information they need to work. eg what does fakegen really do? Where does it get its source information from.
  2. Make all the scripts more understandable. What does detgen.py stand for, even a documentation block in the header would help ?
  3. Document or make the process easier to understand. Its hard at present to work out whats order the scripts are supposed to be run in and how the data flows from one script to another.
  4. Look at rationalising them so that the scripts later in the chain of scripts dont need to know about earlier scripts. eg detgen,py looks for files from ygen, pdngen and does special things on those files. It should not need to know where the previous set of files came from, just that there is source subject information.
ieb commented 12 years ago

It looks like indium.py may address 4 as it takes the details files and processes them into a collection of other files, json, ical, report etc files. The issue might therefore be the generation of the details files rather than the generation of the calendar files.