Fill out documentation in spreadsheet generator code about ingest-client HOT 2 OPEN

Just out of curiosity, why are we reviving this code? I thought the linked_spreadsheet_builder was dead now that the schema template generator is fully implemented.

from ingest-client.

A few thoughts:

1. I actually didn't even realize that that repo existed. When I initially asked for the spreadsheet generator code, I was pointed to ingest-client.

2. That being said, it looks like the above repo fundamentally uses the spreadsheet builder according to this line here: https://github.com/HumanCellAtlas/schema-template-generator/blob/master/generator/template_generator_app.py#L295

3. There seems to be a bunch of duplicate code in that particular repo including a comment that explicitly says "# WARNING: This code duplicates a large section of the ingest-client spreadsheet builder. Updates to the relevant spreadsheet builder code should be mimicked here!" which seems to imply that ingest-client spreadsheet builder is the source of truth. Consolidating code will prevent future bugs/confusion on why two methods of generating spreadsheets may differ.

4. It also seems prudent to consolidate all business logic about spreadsheet generation and parsing into a single location and then split away the presentation logic/layer into its own thing. I would suggest leaving all the presentation logic in schema template generator repo and consolidate spreadsheet logic in ingest-client.

5. The schema template generator repo seems to be also focused on creating a UI to do the generation. I am only interested in programmatically generating spreadsheets thus also fueling the need for point 4 above.

6. Question for you : does the schema template generator code above link columns from different metadata schemas?

from ingest-client.