openMetadataInitiative / bids2openminds

A tool to generate openMINDS metadata from BIDS datasets
MIT License
1 stars 3 forks source link

Provide the BIDS directory on the command-line, not through an input prompt #6

Closed apdavison closed 4 months ago

apdavison commented 5 months ago

Rather than prompt the user to enter the path to the BIDS directory, they should enter it on the command line, like:

$ bids2openminds /path/to/bids/dataset

I recommend using click for this (pybids also uses click).

For integration with the pyproject.toml file, see here.

lzehl commented 5 months ago

@apdavison using this via commandline is then an additional option for the initial translation?

lzehl commented 5 months ago

I think this should not only be command line option, and it should not be an input() (as it is right now). This should be an attribute of a function. There is going to be more interactive (semi-automatic) elements in the future. I think the bids2openminds has to be a python package with main functions the user can interact with and hidden functions (that do all the translations in the background). This would mean the converter.py has to be redefined as a class with functions, no?

lzehl commented 5 months ago

Based on our discussion (@apdavison @Peyman-N) we should go with @apdavison suggestion first and close this ticket. we'll open a separate issue for my concern (later)