Making converter a cmd line script instead of a file that must be edited to be used

[gbarter]

Previously, the windio v1->2 converter had to be edited in the if __name__==__main__ section with the path to the input file. These changes make the converter a command line script where the usage is:

524 09:27:06 gbarter-37067s:~/devel/WindIO/windIO/converters $./windIO2windIO.py --help
usage: windIO2windIO.py [-h] [-i INPUT] [-o OUTPUT]

WindIO v1->v2 Converter

options:
  -h, --help           show this help message and exit
  -i, --input INPUT    Input v1 filename path
  -o, --output OUTPUT  Output v2 filename path

The script is also now executable and can be called from the command line without the python preface if desired.

[gbarter]

@fzahle - Not sure what is tripping up the docs build. Let me know if you want me to dig into that. Did you set that up originally or was that Rafael?

[rafmudaf]

Just fwiw if you configure the [project.scripts] setting in pyproject.toml, you'd have access to the package name as a command line utility. So from any directory (so long as the correct environment is activated), you could do something like windIO --convert-from-v1 oldwindio.yaml. Here's a fairly verbose guide, but you can skip to the end to see the final usage: https://dev.to/demianbrecht/entry-points-in-python-34i3. If you like it, I'm happy to help set it up.

[gbarter]

Just fwiw if you configure the [project.scripts] setting in pyproject.toml, you'd have access to the package name as a command line utility. So from any directory (so long as the correct environment is activated), you could do something like windIO --convert-from-v1 oldwindio.yaml. Here's a fairly verbose guide, but you can skip to the end to see the final usage: https://dev.to/demianbrecht/entry-points-in-python-34i3. If you like it, I'm happy to help set it up.

Great point and reminder. Yes, we do this in WISDEM for a couple scripts. It is a level up on user intrusiveness though, so I'll defer to @kenloen and other keepers of the WindIO to decide if they want to go that route. I would be happy to put in the necessary changes.

[kenloen]

I think it would be great to elevate the converter CLI tool that @gbarter added to a CLI tool of windIO like @rafmudaf suggest.

The exact API for it could potentially be discuss (e.g. should the both the converter and validator be exposed as CLI tools?!). But in the interest of just adding it for now I guess we can just flag as a beta version and that the API might change in the future?

[gbarter]

Sounds good! I have added a windio_converter script that is installed with the package.

[gbarter]

@kenloen - Good to merge here?

[kenloen]

Looks good!
Sorry for not getting back before.

[fzahle]

looks like the docs build CI test fails, maybe that's some of the stuff I tinkered with, so probably something I have to fix...

[gbarter]

looks like the docs build CI test fails, maybe that's some of the stuff I tinkered with, so probably something I have to fix...

I think @ptrbortolotti was able to fix that in #178 . . .

[fzahle]

ah yes. so if you can just cherry-pick that commit, then we can merge