Metadata-Version: 2.2
Name: npdoc-cli
Version: 0.0.2
Summary: Tool for creating command line interfaces derived from numpy style doc strings.
Author: Cole Gray
Author-email: Cole Gray <cole.gray14@gmail.com>
Project-URL: Homepage, https://github.com/d-c-gray/npdoc-cli
Project-URL: Docs, https://d-c-gray.github.io/npdoc-cli/
Project-URL: Issues, https://github.com/d-c-gray/npdoc-cli/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpydoc>=1.7.0
Dynamic: author

# npdoc-cli
A tool built with [argparse](https://docs.python.org/3/library/argparse.html)
that utilizes the [numpy style guide](https://numpydoc.readthedocs.io/en/latest/format.html)
to generate a command line interface (CLI). Paired with auto-generated
documentation with [sphinx](https://www.sphinx-doc.org/en/master/) 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:

```python
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:

```console
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.

```console
pip install npdoc-cli
```

For more information, check out the [documentation](https://d-c-gray.github.io/npdoc-cli/).
