yamlarg

Easy YAML arguments for python scripts.

Usage

python3.8 -m pip install yamlarg

import yamlarg
args = yamlarg.parse('argument_file.yaml')

Example YAML arguments file.

---
string:
  help: Example string parameter.
  type: str
  default: 'default string'
bool_false:
  help: Example boolean with a default of false.
  default: False
  action: 'store_true'
bool_true:
  help: Example boolean with a default of true
  default: True
  action: 'store_false'
list:
  help: List of n number of unnamed arguments.
  default: ''
  nargs: '*'

Running a python script would then look like this.

python3.8 ./script.py --string "this is a test string" --bool_false --bool_true --list a b c

{'string': 'this is a test string', 'bool_false': True, 'bool_true': False, 'list': ['a', 'b', 'c']}

Changelog

• Added "description" as an optional argument for the parse function.
• Changed the description formatting to raw to allow for newlines in the description.