search

cancerDHC / ccdhmodel

CRDC-H model in LinkML, developed by the Center for Cancer Data Harmonization (CCDH)
https://cancerdhc.github.io/ccdhmodel/
BSD 3-Clause "New" or "Revised" License
16 stars 8 forks source link

Revise readme.md reflecting changes in sheet2linkml #163

Closed jooho-lee-kim closed 2 years ago

jooho-lee-kim commented 2 years ago

Is your feature request related to a problem? Please describe.

The README.md is not up to date. We are no longer using ./vendor/sheet2linkml directory, which is also removed from the repo. We should revise the document reflecting the changes we made on ccdhmodel and sheet2linkml repos. The content on Automated generation of YAML can be moved to sheet2linkml repo, and rearranges remaining content.

How important is this feature? Select from the options below: • Low - it's an enhancement but not crucial for work

When will use cases depending on this become relevant? Select from the options below: • Mid-term - 2-4 months

jooho-lee-kim commented 2 years ago

Currently, only the Google Drive API is listed on README.md, but, Google Sheets API also should be enabled to run make generate-model.

gaurav commented 2 years ago

I took a stab at fixing this in PR #164; I'll submit it for review once we've merged PR #127. I've also copied these instructions over to sheet2linkml in PR https://github.com/cancerDHC/sheet2linkml/pull/27.

Currently, only the Google Drive API is listed on README.md, but, Google Sheets API also should be enabled to run make generate-model.

Good catch! I notice that one set of the instructions (https://www.iperiusbackup.net/en/how-to-enable-google-drive-api-and-get-client-credentials/) refers only to the Google Drive API, while the other set of instructions (https://pygsheets.readthedocs.io/en/stable/authorization.html) refers only to the Google Sheets API. I checked my Google Developers Console, and I've only got the Google Sheets API enabled. I'll modify PR #164 to get rid of the reference to the first set of instructions, and to clarify that users only need to enable the Google Sheets API.

jooho-lee-kim commented 2 years ago

FYI. The second document (https://pygsheets.readthedocs.io/en/stable/authorization.html) mentions the Google Drive API. The instruction is right above OAuth Credentials section: "4. Similarly enable the “Drive API”. We require drives api for getting list of spreadsheets, deleting them etc."