yaml-arg-configer 0.1.3

Simplifies the process of parsing command-line arguments and configurations from YAML files

Installation

pip install yaml-arg-configer

YAML Argument Parser

Overview

The YamlArgParser class simplifies the process of parsing command-line arguments and configurations from YAML files, combining default values with those specified via the command line or additional YAML files.

Features

• Default Configuration: Load default settings from a YAML file.
• Command-Line Override: Override default settings using command-line arguments.
• Multiple Configurations: Support for multiple YAML configuration files.
• Help Documentation: Generate help documentation for each configuration option.

Default Configuration YAML File

Create a default configuration file (e.g., defaults.yaml) with settings:

arg1:
  default: ~ # Set arg1 default value to None
  help: "Help documentation for arg1"
arg2:
  default: ~ # Set arg2 default value to None
  help: "Help documentation for arg2"

User Configuration YAML Files

Create user configuration files (e.g., config1.yaml):

arg1: value1 # Set arg1 value to value1

And additional configurations (e.g., config2.yaml):

arg2: value2 # Set arg2 value to value2

Parse Command-Line Arguments

Use the parse_args function to parse command-line arguments:

from yaml_arg_configer import YamlArgParser

yaml_parser = YamlArgParser()
cmd_args = yaml_parser.parse_cmd_args()
# return config with dict format by default
args = yaml_parser.parse_args(cmd_args)

print(args)
# config with argparse.Namespace format
print(yaml_parser.get_args())

Command-Line Usage

Run your script with configuration options:

python my_script.py -dc defaults.yaml -d configs -c config1 config2

• -d, --cfg_dir: Directory containing configuration files.
• -c, --cfg: Names of configuration files to use (without .yaml extension).
• -dc, --default_yaml: Path to the default yaml file, it's optional when a path is passed in YamlArgParser()
• -ctx, --ctx_yaml: Path to the context yaml file, it's optional
• --strict: Constraints user configuration defined in the default_yaml file
• --doc: Get help documentation for a specific argument.
• --docs: Print help documentation for all arguments.

Accessing Configurations

Retrieve parsed configurations using:

print(yaml_parser.get_args_dict())
print(yaml_parser.get_args())
print(yaml_parser['arg1'])

Saving Configurations

Save current configurations to a YAML file:

yaml_parser.save_config('output_config.yaml')

Contributing

Contributions are welcome! Please fork the repository, make your changes, and submit a pull request. Ensure that any new features or bug fixes include appropriate tests.

License

This project is licensed under the MIT License.