auto-usage 0.1.0

A python tool for agenerating or auto-updating usage of python cli tools.

• Auto Usage
  • Installation
  • How to use
  • Usage
    • subcommand: quickstart
    • subcommand: quickstart

Auto Usage

A python tool for auto-generating or auto-updating usage of python cli tools.

Note: This project was created with Cookiecutter and the zhangxianbing/cookiecutter-pypackage project template.

Installation

 # install
 git clone https://github.com/zhangxianbing/auto-usage
 cd auto-usage && pip install .

# usage
 cd /path/to/project
 auto-usage

How to use

Auto-usage works for python cli tools based on argparse or other scripts that support '--help' option for showing help message like the following usage.

For auto-usage using pattern usage: to search where the usage beginning, and using the \ <command> to search where the subcommands beginning, you must make sure your tool's usage following the pattern.

As for project structure, you can refer to this project, or just created with Cookiecutter and the zhangxianbing/cookiecutter-pypackage project template.

Usage

usage: auto-usage [-h] <command> ...

A python tool for auto-generating or auto-updating usage of python cli tools.

optional arguments:
  -h, --help  show this help message and exit

Commands:
  <command>
    quickstart
              quickstart for auto-usage.

subcommand: quickstart

usage: auto-usage quickstart [-h]

optional arguments:
  -h, --help  show this help message and exit

subcommand: quickstart

usage: auto-usage quickstart [-h]

optional arguments:
  -h, --help  show this help message and exit

Note: This usage is auto-generated by zhangxianbing/auto-usage.