Skip to main content

Maps yaml nodes and command line arguments to python function parameters.

Project description


Maps yaml nodes and command line arguments to python function parameters.

To install: pip install configutator Or:

git clone
cd configutator
python3 install

To use:

  1. Create a main function with all the parameters you need, annotated with any defaults.

  2. Use the @ConfigMap and @ArgMap decorators to modify the default mappings if needed.

  3. In the if __name__ == "__main__": block at the bottom of the file call the loadConfig() function.

Here is an example of the most basic use:

from configutator import loadConfig
from sys import argv

def foo(param1, param2, param3=None):

if __name__ == "__main__":
  for argmap in loadConfig(argv, (foo,)):

One thing you need to keep in mind when working with configutator is that the config, command line arguments, and function parameters are all independant. The parameters given to @ConfigMap and @ArgMap are what connects them all. You should never have to change a function signature to modify the command line functionality.

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

configutator-1.0.2.tar.gz (11.2 kB view hashes)

Uploaded source

Built Distribution

configutator-1.0.2-py3-none-any.whl (14.3 kB view hashes)

Uploaded py3

Supported by

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