Skip to content

On the format of the project ZIP file

Some remarks about the format of the project ZIP file (to be discussed):

  • The data and config fields in the data.yml file are superfluous. Indeed, they can only have the values data.csv and config.yml, currently. They should then be dropped.
  • The name of the CSV file should be inferred from the base name of the video file. For instance, if the video file is foo.mp4, then the data file should be named foo.csv. The reason for that is to have a non-ambiguous name for the CSV file, in case one extracts it directly from the ZIP file.
  • The value of format field in the data.yml file, contained in the project ZIP file, must be an integer number. It should be started at 1 and incremented by 1 at each change in the internal format of the project ZIP file.
  • Provisions must be made for backward compatibility. This is not critical for now, but will become necessary once ViCodePy will be released with format > 1. For now, we might only put some boilerplate in the code, as a reminder for the future.
  • More importantly, provisions must be made for forward compatibility. If we load a project ZIP file with a format number higher than the maximum format number supported by the current version, then an error message must be sent to the user, inviting her to upgrade ViCodePy.