LCVcode / jockey

MIT License
2 stars 1 forks source link

CLI help text cleanup #19

Closed LCVcode closed 1 week ago

LCVcode commented 5 months ago

The following corrections need to be made to the CLI help text:

In the below sample of the current help text, you can see an example of the abbreviation list that needs to be changed. Ideally, this would show the most readable version of each object type ({charms, applications, units, machines, hostnames, ips}).

python3 jockey.py --help                                     
usage: jockey.py [-h] [--refresh] [-f FILE]
                 [{charms,charm,c,app,apps,application,applications,a,units,unit,u,machines,machine,m,address,addresses,ips,ip,i,hostnames,hostname,host,hosts,h}] [filters [filters ...]]

Jockey - All your Juju objects at your fingertips.

positional arguments:
  {charms,charm,c,app,apps,application,applications,a,units,unit,u,machines,machine,m,address,addresses,ips,ip,i,hostnames,hostname,host,hosts,h}
<truncated>
johnlettman commented 4 months ago

Would you be open to exploring the use of click and rich?

image

LCVcode commented 4 months ago

Those seem like cool options, thank you. I will definitely look into click as an alternative to argparse. Personally, I am not as excited about enhancing colors myself with rich, but I would be excited for someone else to do it. I will open a follow-up issue for that purpose after I made some changes to the CLI.

LCVcode commented 4 months ago

I am currently working on replacing argparse with click. I will likely change multiple files names as part of this work.