Sitelet https://github.com/trustcrypto/python-onlykey/issues/40
Skip to content

Adding --help for better user experience #40

Description

@ranfdev

Currently there isn't any way to see the available commands.
I can't do onlykey --help.

The python module argparse (which I think is included by default in python), can simplify argument parsing and adds a nicer user experience, by automatically creating an help section.

Are you interested in adding an --help flag?
Can i do a pull request introducing argparse and adding the --help flag?

https://docs.python.org/3/library/argparse.html

Activity

changed the title [-]Using argparse for better user experience[/-] [+]Adding --help for better user experience[/+] on Nov 12, 2020

onlykey commented on Nov 13, 2020

@onlykey
Contributor

@ranfdev The --help flag was added here

elif sys.argv[1] == '--help':

but right now its only printing this:

See available command options here https://docs.crp.to/command-line.html

So you still have to go to the docs to see command options

altsalt commented on Aug 15, 2021

@altsalt

@ranfdev seems to have put in the initial effort to resolve this. May I ask what is still needed? Being able to query the commands without having a browser open would be appreciated.

onlykey commented on Aug 16, 2021

@onlykey
Contributor

Currently, in order to ensure the most up-to-date command options we have those available in our docs at the link provided. The PR for argparse had some issues working with some of the commands so that remains open until we are able to resolve argparse issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions