Metadata-Version: 2.1
Name: auto_usage
Version: 1.0.1
Summary: A python tool for agenerating or auto-updating usage of python cli tools.
Home-page: https://github.com/zhangxianbing/auto-usage
Author: zhangxianbing
License: UNKNOWN
Description: <!-- START doctoc generated TOC please keep comment here to allow auto update -->
        <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
        
        - [Auto Usage](#auto-usage)
          - [Installation](#installation)
          - [How to use](#how-to-use)
          - [Usage](#usage)
            - [subcommand: quickstart](#subcommand-quickstart)
        
        <!-- END doctoc generated TOC please keep comment here to allow auto update -->
        
        # Auto Usage
        
        A python tool for auto-generating or auto-updating usage of python cli tools.
        
        > Note: This project was created with [Cookiecutter](https://github.com/cookiecutter/cookiecutter) and the [`zhangxianbing/cookiecutter-pypackage`](https://github.com/zhangxianbing/cookiecutter-pypackage) project template.
        
        ## Installation
        
        ```bash
         # install
        pip install auto-usage
        
        # usage
         cd /path/to/project
         auto-usage
        ```
        
        ## How to use
        
        Auto-usage works for python cli tools based on [argparse](https://docs.python.org/3/library/argparse.html), [click](https://github.com/pallets/click) or other scripts that support '--help' option for showing help message like the following [usage](#Usage).
        
        For auto-usage using regex pattern `^[uU]sage: ` to search where the usage beginning, and using `^[cC]ommands:\s*$` 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](https://github.com/cookiecutter/cookiecutter) and the [`zhangxianbing/cookiecutter-pypackage`](https://github.com/zhangxianbing/cookiecutter-pypackage) project template.
        
        ## Usage
        
        ```
        usage: auto-usage [-h] [-V] [-c COMMAND] <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
          -V, --version         show program's version number and exit
          -c COMMAND, --command COMMAND
                                main command, default is "python -m auto_usage"
        
        Commands:
          <command>
            quickstart          quickstart for auto-usage.
        
        ```
        
        ### 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](https://github.com/zhangxianbing/auto-usage).
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
