Proposals for reorganizing `ccdhmodel` repository
Opened this issue · 1 comments
I had a few ideas to make the ccdhmodel
repository more maintainable and readable.
- #137
- Decide if we want to name the artifacts folder
crdch_model
or something else? - #113
- The MakeConfig file that's currently in a folder called
from_template
can be moved from outside that folder into the root of theccdhmodel
repo. - Per my suggestion in issue #95, we will create a general
vendor
folder instead of a specificgenerators/google-sheets
folder.-
As I understand it though, @gaurav created issue #100 that describes the creation of a separate repo for
sheet2linkml
. I had some suggestions for this too. -
We can add a
setup.py
file to sheet2linkml to make it a package. -
We don't need to publish
sheet2linkml
to PyPI. We can always support the installation of a package directly from the Github repo, by running the below command.$ pip install git+ssh://git@github.com/myuser/foo.git
-
- If we don't need the local folder, we can drop it? Or was there a specific reason at to why that was created?
-
model
isn't the most descriptive name for the linkml model folder. It should be more semantic, so perhaps we can consider renaming it tolinkml-model
or something along those lines?
All of these suggestions sounds great to me, Sujay! I've turned it into a task list so we can track which of these subissues have been completed. This also makes it easy to convert a task into a separate issue if we need to.
The only one I'd push back against at all is "Remove examples-for-discussion folder and create a separate repo for it." -- I think this repo is probably the best place for those examples, except maybe for the Example Data Workflow. But I could be persuaded otherwise.
I don't think we should work on any of these this month, unless fixing any of these issues would help with the CCDH Pilot project. I've added it to one of our December milestones, so we'll work on this in October/November/December, I think.