Skip to main content

Easy YAML arguments for python scripts.

Project description

yarg

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']}

Project details


Download files

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

Source Distribution

yamlarg-0.0.1.tar.gz (1.9 kB view hashes)

Uploaded Source

Built Distribution

yamlarg-0.0.1-py3-none-any.whl (6.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page