Bug#1026818: ITP: usagef -- A tool to print formatted usage messages

[Justin Morgan <2justinmorgan@gmail.com>]

Package: wnpp
Severity: wishlist
Owner: Justin Morgan <2justinmorgan@gmail.com>
X-Debbugs-Cc: debian-devel@lists.debian.org, 2justinmorgan@gmail.com

* Package name    : usagef
  Version         : 0.1.0
  Upstream Author : Name <2justinmorgan@gmail.com>
* URL             : https://github.com/litelibs/usagef/
* License         : (MIT/X)
  Programming Lang: (C)
  Description     : A tool to print formatted usage messages

Designed for developers of shell scripts, the usagef terminal tool
prints consistent formatted usage messages that contain the information
passed as argv args of the usagef program. 

Here is an example of how usagef can be used to print the usage message
of a custom script, deploy.sh.

$ usagef \
  --name "deploy.sh" \
  --argv "[options] <environment> <package>" \
  --description "Deploy a package to the specified environment" \
  --item "Options:-f, --force:Forces the deployment" \
  --item "Options:-t, --api-token <token>:Specify the api token used" \
  --item "Options:-r, --report <email>:Email a report to someone" \
  --item "Options:-j, --json:Prints output in json format" \
  --item "Environment:dev:Deploy to dashboard.dev.company.com" \
  --item "Environment:preprod:Deploy to dashboard.preprod.company.com" \
  --item "Environment:prod:Deploy to dashboard.company.com" \
  --item "Package:user:Deploys updated user accounts" \
  --item "Package:security:Deploys vetted security protocols"  \
  --item "Package:logging:Deploys a new, and archives old logs"

[OUTPUT]

Usage: deploy.sh [options] <environment> <package>

Deploy a package to the specified environment

Options:
  -f, --force              Forces the deployment
  -t, --api-token <token>  Specify the api token used
  -r, --report <email>     Email a report to someone
  -j, --json               Prints output in json format

Environment:
  dev      Deploy to dashboard.dev.company.com
  preprod  Deploy to dashboard.preprod.company.com
  prod     Deploy to dashboard.company.com

Package:
  user      Deploys updated user accounts
  security  Deploys vetted security protocols
  logging   Deploys a new, and archives old logs



- Why is this package useful/relevant? 
  This package is useful because it bypasses the repeat efforts of
  maintaining consistent formatting of shell script usage messages.
- Is it a dependency for another package?
  No, this is not a dependency for another package.
- Do you use it?
  Yes, it is self-used. A few prototypes have been developed, thus inspiring
  the development of this package.
- If there are other packages providing similar functionality, how does it
  compare?
  There are no known packages that provide similar functionality.
- How do you plan to maintain it?
  Maintenance is planned to be a request-driven method that serves
  user's needs mentioned in https://github.com/litelibs/usagef/issues.
- Inside a packaging team (check list at https://wiki.debian.org/Teams)?
  No, maintenance will not be coordinated via Debian teams. However, a team at
  https://wiki.debian.org/Teams may be needed for future works of usagef.
- Are you looking for co-maintainers?
  No, a co-maintainer is not needed. However, a co-maintainer may be needed for
  future works of usagef.
- Do you need a sponsor?
  No, it is believed that a sponsor is not needed. However, a sponsor would be
  nice to have.