npdoc-cli 0.0.2

Tool for creating command line interfaces derived from numpy style doc strings.

npdoc-cli

A tool built with argparse that utilizes the numpy style guide to generate a command line interface (CLI). Paired with auto-generated documentation with sphinx you can maintain a function's source code, documentation, and CLI all with the same chunk of text.

For example a simple CLI for a function can be made with:

from npdoc_cli import cli

@cli.program
def hello(name: str):
    """
    Say hello!

    Parameters
    ----------
    name : str
        Who is being greeted.
    """
    print('hello', name)

cli.build()
cli.print_help()

Which produces a help message like:

usage: hello [-h] name

Say hello!

positional arguments:
  name        Who is being greeted.

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

Install with pip.

pip install npdoc-cli

For more information, check out the documentation.