Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve CLI for batch scripts #74

Open
nmarchio opened this issue Nov 30, 2022 · 4 comments
Open

Improve CLI for batch scripts #74

nmarchio opened this issue Nov 30, 2022 · 4 comments
Labels
enhancement New feature or request good first issue Good for newcomers package management Improve how to install, upgrade, configure software priority High priority issue

Comments

@nmarchio
Copy link
Member

nmarchio commented Nov 30, 2022

https://github.com/mansueto-institute/kblock/tree/main/kblock

Place all functions into a python module file.
Explore whether converting batch_*.py scripts to CLIs using click (instead of argparse) makes sense
Standardize the arguments for the CLIs
Generalize tests to confirm all countries in input list have associated files
Add argument to skip countries with output files that already exist
Lint everything consistently (pep8)

@nmarchio nmarchio added enhancement New feature or request good first issue Good for newcomers package management Improve how to install, upgrade, configure software priority High priority issue labels Nov 30, 2022
@manmartgarc
Copy link
Collaborator

Just curious: why forcing use of click instead of the native argparse?

@nmarchio
Copy link
Member Author

After I do this final deployment and code refactor involving some significant feature enhancements and bug fixes, I'm hoping to package everything up and as part of that effort it might be a good time to shift over to click. Argparse works well for now. The main issue if we open this to a broader community of users, click can make the CLI a bit more user friendly.

We can discuss of course, right now its more of a nice to have.

@manmartgarc
Copy link
Collaborator

After I do this final deployment and code refactor involving some significant feature enhancements and bug fixes, I'm hoping to package everything up and as part of that effort it might be a good time to shift over to click. Argparse works well for now. The main issue if we open this to a broader community of users, click can make the CLI a bit more user friendly.

We can discuss of course, right now its more of a nice to have.

I am not sure I understand how click can make the CLI more user friendly relative to argparse, or what user friendliness means in the context of a CLI.

On the developer side, argparse is the common standard (by fact of being a built-in) so it's more often used.

@nmarchio
Copy link
Member Author

nmarchio commented Dec 1, 2022

Cool make some edits to the issue to be less comittal around click

@nmarchio nmarchio changed the title Click-ify all batch scripts Improve CLI for batch scripts Dec 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers package management Improve how to install, upgrade, configure software priority High priority issue
Projects
None yet
Development

No branches or pull requests

2 participants