Refactor cli.py for cleaner options on cli help #172

naik-aakash · 2023-10-22T16:39:37Z

Will close #139 and #162

Major Change

Arguments have been regrouped and commented (help understanding and modifications in future better)
All the actions now will show help correctly (Will show only the files necessary for running it and what options are available specific to that action)

Todo

After merging orbital-wise analysis PR, update the final bit.

…check default plot-dos

naik-aakash · 2023-10-24T08:42:04Z

Hi @JaGeo , this PR is ready to be reviewed and merged

JaGeo · 2023-10-24T10:15:35Z

Maybe later today. Need time for this.

JaGeo · 2023-10-24T11:45:11Z

Hi @naik-aakash , I think this already looks great. I was wondering if one should introduce very short options in the cli as well (see here https://nullprogram.com/blog/2020/08/01/)

I am not an expert with cli design. @ajjackson, do you maybe have time to your give opinion on this?

JaGeo · 2023-10-24T13:08:53Z

I am also wondering if our naming schema of the commands is really that good:
In this reference, they provide some suggetions, e.g. starting all commands that deal with files with "file-"
https://medium.com/jit-team/guidelines-for-creating-your-own-cli-tool-c95d4af62919

JaGeo · 2023-10-24T13:11:26Z

Maybe the following could work:

description
description-quality
plot-automatic, plot-auto (and former names)
create-inputs
plot-dos
plot-icohp-distance
plot

?

We coud sort them in a alphabetical order as well.

naik-aakash · 2023-10-24T13:21:54Z

Hi @naik-aakash , I think this already looks great. I was wondering if one should introduce very short options in the cli as well (see here https://nullprogram.com/blog/2020/08/01/)

I am not an expert with cli design. @ajjackson, do you maybe have time to your give opinion on this?

I think introducing very short options are not a good idea, could lead to more confusion. But naming conventions , I can try to find more besides the resources you shared.

JaGeo · 2023-10-24T13:28:02Z

Just wait a few more minutes with changing anyhting. I am currently refining some of the other texts. I will push the changes soon.

naik-aakash · 2023-10-24T13:37:12Z

Just wait a few more minutes with changing anyhting. I am currently refining some of the other texts. I will push the changes soon.

Sure, am not actively on the code now , so no rush 😃

JaGeo · 2023-10-24T13:37:27Z

I have updated and simplified the language in the description a bit. I don't think "will ...." is very helpful here. Maybe, check yourself.

And, my recommendations for new argument names are above. I think this would simplify the interface a lot.

naik-aakash · 2023-10-24T13:49:57Z

I have updated and simplified the language in the description a bit. I don't think "will ...." is very helpful here. Maybe, check yourself.

And, my recommendations for new argument names are above. I think this would simplify the interface a lot.

Thanks! Your changes reads much better

ajjackson · 2023-10-25T10:59:38Z

I am on parental leave at the moment. I can try to give this a look over at some point but can't promise precisely when!

JaGeo · 2023-10-25T11:16:22Z

I am on parental leave at the moment. I can try to give this a look over at some point but can't promise precisely when!

Don't worry! We will probably continue as described above. If you have time or are back from parental leave, we are happy to include further advice, recommendations!

naik-aakash · 2023-10-26T10:30:49Z

Maybe the following could work:

description

description-quality

plot-automatic, plot-auto (and former names)

create-inputs

plot-dos

plot-icohp-distance

plot

?

We coud sort them in a alphabetical order as well.

Done, I sorted them and tried to do this for sub-args where it was possible as well

JaGeo · 2023-10-26T16:01:31Z

lobsterpy/cli.py

-        default="lobsterout",
+    coxxcar_file = argparse.ArgumentParser(add_help=False)
+    coxxcar_file.add_argument(
+        "--file-cohpcar",


While this is cleaner, we should leave cohpcar as an alias in any case.

Should we have such an option for all others as well?

I was thinking maybe I add a shorthand alias like -fcohp or so for all the file-related args. Could be much more intuitive?

-fcohp sounds good

naik-aakash · 2023-10-27T16:43:21Z

Done with the changes here 😄

JaGeo · 2023-10-27T17:28:53Z

I will try to do it next week

lobsterpy/cli.py

JaGeo · 2023-10-28T09:23:38Z

lobsterpy/cli.py

-    broadening_group.add_argument(
-        "--sigma",
+    plotting_group.add_argument(
+        "-fs",


Can you check elsewhere what they use?

Also, the f might be confusing now with the files.

removed this short notation

JaGeo · 2023-10-28T09:33:21Z

lobsterpy/cli.py

@@ -224,7 +239,15 @@ def get_parser() -> argparse.ArgumentParser:
            "stylesheets when using --style."
        ),
    )
-    plotting_group.add_argument("--title", type=str, default="", help="Plot title")
+    plotting_group.add_argument(
+        "-sty",


Wondering what other codes use

Thanks! Will check it out

Could not find this in other codes, I think it should be fine

JaGeo · 2023-10-28T09:34:09Z

lobsterpy/cli.py

    plotting_group.add_argument(
-        "--width", type=float, default=None, help="Plot width in inches"
+        "-wd",


Same comment as before. I guess standards should exist for the short notation

I checked into this, usually -w is used. The short notation for height arg will be -h which creates a conflict with default -h arg for helo. So I feel -wd and -ht will keep it bit consistent.

JaGeo · 2023-10-28T09:41:12Z

Thanks. Looks much better already. I am wondering if there are standards in the community for short commands for font size, style etc

And, if you have a dos plotter, you can orobably just say -addtotal instead of addtotaldos etc.

naik-aakash · 2023-10-28T14:44:24Z

Thanks. Looks much better already. I am wondering if there are standards in the community for short commands for font size, style etc

And, if you have a dos plotter, you can orobably just say -addtotal instead of addtotaldos etc.

Oh yes , Thanks! Will change it 😃

JaGeo · 2023-10-28T14:53:38Z

I don't have much experience with this but I recommend keeping the commands short.

naik-aakash · 2023-11-09T07:28:26Z

Hi @JaGeo , this could be merged as well now

naik-aakash and others added 5 commits October 22, 2023 18:32

refactor cli.py for cleaner options on cli help

0553d82

fix mypy error

4376199

Merge branch 'main' into update_cli

f740f28

run black for linting error

fb6d821

update help description, set default for plotdos arg, update test to …

a7c616c

…check default plot-dos

naik-aakash changed the title ~~[WIP] refactor cli.py for cleaner options on cli help~~ Refactor cli.py for cleaner options on cli help Oct 24, 2023

naik-aakash mentioned this pull request Oct 24, 2023

Some train 🚂 thoughts #162

Closed

Fix input warning cli

7f7ca05

unify language

0dce1b6

linting fix

aa9181c

rename args, aplhabetical order, update tests

5e3ead3

JaGeo reviewed Oct 26, 2023

View reviewed changes

add more options for cli.py

925a870

JaGeo reviewed Oct 28, 2023

View reviewed changes

lobsterpy/cli.py Outdated Show resolved Hide resolved

JaGeo reviewed Oct 28, 2023

View reviewed changes

lobsterpy/cli.py Outdated Show resolved Hide resolved

JaGeo reviewed Oct 28, 2023

View reviewed changes

lobsterpy/cli.py Outdated Show resolved Hide resolved

JaGeo reviewed Oct 28, 2023

View reviewed changes

naik-aakash added 3 commits November 1, 2023 10:28

address review comments

8e947c4

remove confusing -fs arg for fontsize

51c9269

resolve merge conflicts

0440528

JaGeo approved these changes Nov 9, 2023

View reviewed changes

JaGeo merged commit 22923b3 into JaGeo:main Nov 9, 2023
23 checks passed

naik-aakash deleted the update_cli branch June 20, 2024 06:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor cli.py for cleaner options on cli help #172

Refactor cli.py for cleaner options on cli help #172

naik-aakash commented Oct 22, 2023 •

edited

Loading

naik-aakash commented Oct 24, 2023

JaGeo commented Oct 24, 2023

JaGeo commented Oct 24, 2023

JaGeo commented Oct 24, 2023

JaGeo commented Oct 24, 2023 •

edited

Loading

naik-aakash commented Oct 24, 2023

JaGeo commented Oct 24, 2023

naik-aakash commented Oct 24, 2023

JaGeo commented Oct 24, 2023

naik-aakash commented Oct 24, 2023

ajjackson commented Oct 25, 2023

JaGeo commented Oct 25, 2023

naik-aakash commented Oct 26, 2023

JaGeo Oct 26, 2023

naik-aakash Oct 27, 2023 •

edited

Loading

JaGeo Oct 27, 2023

naik-aakash commented Oct 27, 2023

JaGeo commented Oct 27, 2023

JaGeo Oct 28, 2023

naik-aakash Nov 1, 2023

JaGeo Oct 28, 2023

naik-aakash Oct 28, 2023 •

edited

Loading

naik-aakash Nov 1, 2023

JaGeo Oct 28, 2023

naik-aakash Nov 1, 2023

JaGeo commented Oct 28, 2023 •

edited

Loading

naik-aakash commented Oct 28, 2023

JaGeo commented Oct 28, 2023

naik-aakash commented Nov 9, 2023

Refactor cli.py for cleaner options on cli help #172

Refactor cli.py for cleaner options on cli help #172

Conversation

naik-aakash commented Oct 22, 2023 • edited Loading

Major Change

Todo

naik-aakash commented Oct 24, 2023

JaGeo commented Oct 24, 2023

JaGeo commented Oct 24, 2023

JaGeo commented Oct 24, 2023

JaGeo commented Oct 24, 2023 • edited Loading

naik-aakash commented Oct 24, 2023

JaGeo commented Oct 24, 2023

naik-aakash commented Oct 24, 2023

JaGeo commented Oct 24, 2023

naik-aakash commented Oct 24, 2023

ajjackson commented Oct 25, 2023

JaGeo commented Oct 25, 2023

naik-aakash commented Oct 26, 2023

Choose a reason for hiding this comment

naik-aakash Oct 27, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

naik-aakash commented Oct 27, 2023

JaGeo commented Oct 27, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

naik-aakash Oct 28, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JaGeo commented Oct 28, 2023 • edited Loading

naik-aakash commented Oct 28, 2023

JaGeo commented Oct 28, 2023

naik-aakash commented Nov 9, 2023

naik-aakash commented Oct 22, 2023 •

edited

Loading

JaGeo commented Oct 24, 2023 •

edited

Loading

naik-aakash Oct 27, 2023 •

edited

Loading

naik-aakash Oct 28, 2023 •

edited

Loading

JaGeo commented Oct 28, 2023 •

edited

Loading