Update purldb-toolkit and related README files #249

[johnmhoran]

Reference: #249
Reference: #446

[AyanSinhaMahapatra]

@johnmhoran LGTM and thanks! See couple nits and suggestions for your consideration.

[AyanSinhaMahapatra]

Here instead of three dots at the end, we can show the full texts which are there when we run purlcli --help, for all 4 commands here. Otherwise the truncated texts are not that useful.

[johnmhoran]

Actually @AyanSinhaMahapatra when I ran purlcli --help I got the same truncated texts. I'll postpone this change until you've had a chance to read this reply in case that changes your thinking. I like the idea of more info, but as you'll see in the examples below, the description for instance for metadata is rather long -- just want to make sure we're OK with the way this wraps due to its length when we insert it into the purlcli --help output block in the RTD.

This is purlcli --help:

$ purlcli --help
Usage: purlcli [OPTIONS] COMMAND [ARGS]...

  Return information from a PURL.

Options:
  --help  Show this message and exit.

Commands:
  metadata  Given one or more PURLs, for each PURL, return a mapping of...
  urls      Given one or more PURLs, for each PURL, return a list of all...
  validate  Check the syntax and upstream repo status of one or more PURLs.
  versions  Given one or more PURLs, return a list of all known versions...

And this is purlcli metadata --help:

$ purlcli metadata --help
Usage: purlcli metadata [OPTIONS]

  Given one or more PURLs, for each PURL, return a mapping of metadata fetched
  from the fetchcode package.py info() function.

Options:
  --purl TEXT        PackageURL or PURL.
  --output FILENAME  Write meta output as JSON to FILE.  [required]
  --file FILENAME    Read a list of PURLs from a FILE, one per line.
  --help             Show this message and exit.

[johnmhoran]

@AyanSinhaMahapatra I've just committed and pushed my updates responding to your comments (thank you for those). One open item concerns your comment re the truncated text in purlcli --help -- I noted that the full text might be long enough to wrap and some might find that unsightly. Please let me know at your convenience how you'd like me to handle that.

[AyanSinhaMahapatra]

@johnmhoran here's some directions on the truncated help text: https://stackoverflow.com/questions/75036688/display-full-help-text-in-python-click, but let's not do too much here. We should rather keep this short and concise so it fits the CLI display (first line of a docstring short text for this, next paragraph for detailed docstring). LGTM otherwise!

[AyanSinhaMahapatra]

@johnmhoran let's handle this seperately in #455, merging the PR otherwise, thanks!

[johnmhoran]

Thank you @AyanSinhaMahapatra 👍