smart-on-fhir / cumulus-library

https://docs.smarthealthit.org/cumulus/library/
Apache License 2.0
2 stars 0 forks source link

Make it easier to run studies from git checkouts #235

Closed mikix closed 1 month ago

mikix commented 1 month ago

This also bumps ruff's version to 0.4.4 and has the commit hook just auto-commit any formatting changes.

Checklist

mikix commented 1 month ago

I didn't see any changes needed in the template repo, mostly because (1) it doesn't include any builders that try to import anything, (2) it doesn't use the two-level directory setup that some released studies like covid have had to use, and (3) its instructions talk about renaming the study folder already to match a python module name and to also rename study_prefix.

So I think it should be fine both before and after this change, but your naming can be more flexible after this PR

dogversioning commented 1 month ago

I didn't see any changes needed in the template repo, mostly because (1) it doesn't include any builders that try to import anything, (2) it doesn't use the two-level directory setup that some released studies like covid have had to use, and (3) its instructions talk about renaming the study folder already to match a python module name and to also rename study_prefix.

So I think it should be fine both before and after this change, but your naming can be more flexible after this PR

We should maybe chat about whether maintaining the template repo even makes sense - The example config file in the docs might be the 'right' way to telegraph how to make studies at this point.