| docs | |
| tests |    |
| package |    |
Welcome! Additionally to the default behaviour of the argparse.ArgumentParser, the funcargparse.FuncArgParser allows you to
- automatically create a parser entirely from the docstring of a function, including the help, metavar, action, type and other parameters
- Let's you
chain subparsers <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 getting_started for more information.
getting_started docstring_interpretation api/funcargparse changelog
Simply install it via pip:
$ pip install funcargparseOr you install it via:
$ python setup.py installfrom the source on GitHub.
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.
Copyright 2016-2019, Philipp S. Sommer
Copyright 2020-2021, Helmholtz-Zentrum Hereon
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
genindexmodindexsearch