search

DAI-Lab / cookiecutter-pypackage

DAI Lab's adaptation of cookiecutter-pypackage
BSD 3-Clause "New" or "Revised" License
1 stars 5 forks source link

Allow user to choose from click and argparse #10

Open csala opened 5 years ago

csala commented 5 years ago

This is arguably a subjective preference, but I would advocate against using Click, in favor of argparse.

Among other things, the main reason is that for Click to work, the code needs to be prepared for that. On the contrary, argparse can be used to call any function, even if it was previously not prepared to be run directly from the command line interface.

Another reason is that argparse does not introduce any third party dependency, as it is part of stdlib, while click does.

Further details of this discussion can be seen here: https://medium.com/@collectiveacuity/argparse-vs-click-227f53f023dc

Another option would be to remove the cli.py module from this template altogether, as most of the projects end up implementing the CLI commands somewhere else anyway.

micahjsmith commented 5 years ago

Sounds fine to make argparse the default CLI library, I have no strong preference. Lets keep Click as an option because some people strongly prefer it and we don't need to make a judgment.

It should not be a problem to have Click as a non-stdlib dependency as it is frequently a dependency of other libraries anyway. Let's keep cli.py in as an opinionated way to develop a cli. It is a suboptimal pattern IMO to have CLI functionality scripts/foo.py, scripts/bar.py as we have in some HDI projects right now.

csala commented 5 years ago

Since having the cli.py is optional, I agree on keeping it. Regarding argparse vs click, do you mean making it a new cookiecutter optional?

If so, I agree on doing that.

micahjsmith commented 5 years ago

Yes, I would say make it three options: argparse (default, creates cli.py with stub argparse-base cli), click, and none (does not create cli.py) On Thu, Sep 20, 2018 at 14:15 Carles Sala notifications@github.com wrote:

Since having the cli.py is optional, I agree on keeping it. Regarding argparse vs click, do you mean making it a new cookiecutter optional?

If so, I agree on doing that.

— You are receiving this because you commented.

Reply to this email directly, view it on GitHub https://github.com/DAI-Lab/cookiecutter-pypackage/issues/10#issuecomment-423282210, or mute the thread https://github.com/notifications/unsubscribe-auth/AFOFRtbekQJ9pMB24jO5awnQft20ZLtwks5uc9tBgaJpZM4WtvV2 .

micahjsmith commented 5 years ago

Look into the usage of __main__.py, especially for python -m switch, and also for overall cli implementation.

micahjsmith commented 5 years ago

We propose to add a __main__.py to enable the python -m switch

We also are considering two options:

In the course of considering these options, we are surveying existing OSS projects to see which conventions are widely used and evaluating the evidence for and against.