search

csdms / babelizer

Transform BMI-wrapped models into Python packages
https://babelizer.readthedocs.io
MIT License
4 stars 3 forks source link

Add output option to quickstart command #12

Closed mdpiper closed 4 years ago

mdpiper commented 4 years ago

This PR adds an --output option to the babelize quickstart command, and updates the README to show its use. Also fixed a few small issues in the README.

mcflugen commented 4 years ago

@mdpiper I had intentionally left out this option. I didn't like the idea of the behavior of the command changing depending on user-supplied options. As it exists, a user can always redirect output to a given file so I'm not sure this option adds anything? Is quickstart --output=babel.toml easier than quickstart > babel.toml?

As a compromise, how about adding a new argument that is the name of the output file? Like a well-behaved UNIX-style command, if passed a - it would write to stdout. So the following would be equivalent:

$ quickstart babel.toml
$ quickstart - > babel.toml

This seems more standard. What do you think?

mcflugen commented 4 years ago

@mdpiper While we're at it, what do you think about changing the name of the quickstart subcommand? I've never really been fond of it. I prefer subcommand names be verbs. How about generate? I think it is maybe more descriptive and will read better,

$ babelize generate babel.toml

sounds better and is more descriptive of what is happening than

$ babelize quickstart babel.toml
mdpiper commented 4 years ago

Oh, OK--not a problem. I'd like to show the redirect in the README, though. I'll close this PR.

And, yeah, I like babelize generate.