Skip to main content

Create an argparse.ArgumentParser from function docstrings

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
funcargparse-0.2.0.tar.gz (18.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page