funcargparse

Create an argparse.ArgumentParser from function docstrings


Keywords
argparse re docrep
License
GPL-2.0
Install
pip install funcargparse==0.2.2

Documentation

Create an argparse.ArgumentParser from function docstrings

docs Documentation Status
tests Travis Requirements Status Coverage
package PyPI Package latest release Supported versions Supported implementations

Welcome! Additionally to the default behaviour of the argparse.ArgumentParser, the funcargparse.FuncArgParser in this package allows you to

  1. automatically create a parser entirely from the docstring of a function, including the help, metavar, action, type and other parameters
  2. Let's you chain subparsers

There are a lot of argparse extensions out there, but through the use of the docrep package, this package can extract much more information to automate the creation of the command line utility.

See the documentation for more information.

Installation

Simply install it via pip:

$ pip install funcargparse

Or you install it via:

$ python setup.py install

from the source on GitHub.

Requirements

The package only requires the docrep package which we use under the hood to extract the necessary parts from the docstrings.

The package has been tested for python 2.7 and 3.5.