forikal-uk/gsheet-to-xml

Command for parsing Google Drive URLs and converting sheets to XML.

sheet-to-xml

Symfony Console command that, given the URL of a (specifically structured) Google Sheet or Google Drive folder of sheets, outputs the contents (perhaps in multiple tabs) in the form of Xml., _(*1)

Designed be used in the context of the Symfony Console application at https://github.com/xmlsquad/xml-authoring-tools which, in turn, is used in the context of a known directory structure which is based on xml-authoring-project., _(*2)

Documentation

See: https://github.com/xmlsquad/gsheet-to-xml/blob/master/DOCUMENTATION.md, _(*3)

Original Specification:

Schema descriptions

I have published, _(*4)

• a schema defining how the Google Sheets map to Xml.
• an example Inventory sheet.
• an example Xml representation of Inventory data.
• some of the rules that define the valid structure of an Inventory sheet.

Naming convention.

Given a Google Sheet, unless the sheet's name implies it is 'ignored', it is assumed that its structure is valid structure of an Inventory sheet. Given a Google Drive folder, it is assumed that any Google Sheets found within have the valid structure of an Inventory sheet (unless the sheet's name implies it is 'ignored')., _(*5)

A Google sheet's with a trailing underscore in their name imply that it should be 'ignored'. A Google sheet tab's with a trailing underscore in their name imply that it should be 'ignored'., _(*6)

If a file is called foo, then it is validated as normal. If a file is called foo_, then it is assumed to be 'private' and should be explicitly ignored, but it should be noted (in any feedback) that it was ignored. If a Google Sheet's tab is named foo, then it is validated as normal. If a Google Sheet's tab is named foo_, then it is assumed to be 'private' and should be explicitly ignored, but it should be noted (in any feedback) that it was ignored., _(*7)

Input

• driveUrl: The URL of the Google Drive entity (Google Sheet or Google Drive folder)., _(*8)

• is-recursive: if the Google Drive entity is a Google Drive folder, this option specifies whether or not to recurse through sub-directories to find sheets., _(*9)

Behaviour

If the driveUrl is a Google Sheet write out the contents as Xml. If it is a Google Drive find all Google Sheets within the directory (recursively, if specified) and write out the contents as Xml., _(*10)

Output

STD_OUT, _(*11)

Streamed output., _(*12)

Xml representation of the Inventory data in the Google Sheet., _(*13)