dynamic-cli-builder 0.1.22

A Python library for dynamically building CLI tools from YAML configurations.

Dynamic CLI Builder

Dynamic CLI Builder is a tool that simplifies the creation of interactive command-line interfaces (CLI) with minimal changes to your Python scripts, you can enable CLI functionality by adding methods to the registry and describing the CLI structure using YAML.

Features

• Easy to use
• Highly customizable
• Supports multiple command structures
• Interactive cli
• custom rules
• Logging

Installation

To install Dynamic CLI Builder, use the following command:

pip install dynamic-cli-builder

Usage

Here is a simple example to get you started:

Create Actions

Actions are basically function to be executed base on command.
For instance actions.py

def say_hello(name: str, age: int):
    print(f"Hello {name}!, you are {age} years old.")

# Action Registry
ACTIONS = {
    "say_hello": say_hello,
}

you can have multiple function registered

Create yaml config

config.yaml

description: "Dynamic CLI Builder Example"
commands:
  - name: say_hello
    description: "Say Hello..."
    args:
      - name: name
        type: str
        help: "Name of the user."
    action: say_hello

Add rules for custom validation

• min, max validation

description: "Dynamic CLI Builder Example"
commands:
  - name: say_hello
    description: "Say Hello..."
    args:
      - name: name
        type: str
        help: "Name of the user."
      - name: age
        type: int
        help: "Age of the user."
        rules:
          min: 1
          max: 99
    action: say_hello

• for more control, you could also use regex

description: "Dynamic CLI Builder Example"
commands:
  - name: say_hello
    description: "Say Hello..."
    args:
      - name: name
        type: str
        help: "Name of the user."
      - name: age
        type: int
        help: "Age of the user."
        rules:
          regex: "^[1-9][0-9]$"
    action: say_hello

Main file main.py

To bind this all together

from dynamic_cli_builder import run_builder
from actions import ACTIONS

run_builder('config.yaml', ACTIONS)

CLI Command

Global Help

python3 <name_of_main_file> -h

For Instance:

python3 main.py -h

command specific help

 python3 <name_of_main_file> <name_of_command> -h

For Instance:

python3 main.py say_hello --name world --age 99

You should see

Hello World!, you are 99 years old

Logging Mode

logging is set to false by default, to enable logging add -log to your command just after the file name

python3 main.py -log say_hello --name world --age 99

Output:

2025-01-29 12:08:19,518 - INFO - Building CLI with config.

2025-01-29 12:08:19,532 - INFO - Executing command: say_hello

Hello World!, you are 99 years old.

Interactive Mode

Interactive mode is set to false by default to enable interactive mode, add -im to your command For instance:

python3 main.py -im say_hello --name world --age 99