Skip to main content

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

Project description

Dynamic CLI Builder

Dynamic CLI Builder is a tool to help you create command-line interfaces (CLI) dynamically with ease.

Features

  • Easy to use
  • Highly customizable
  • Supports multiple command structures

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):
    print(f"Hello, {name}!")

# 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: hello
    description: "Say Hello..."
    args:
      - name: name
        type: str
        help: "Name of the user."
    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 -h

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

dynamic_cli_builder-0.1.5.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dynamic_cli_builder-0.1.5-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

Details for the file dynamic_cli_builder-0.1.5.tar.gz.

File metadata

  • Download URL: dynamic_cli_builder-0.1.5.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.12

File hashes

Hashes for dynamic_cli_builder-0.1.5.tar.gz
Algorithm Hash digest
SHA256 689c7aca4fd8541e89fee9f70f873d794c5b0443ef7b2c99dec8216f61a490e2
MD5 b6fd904815304673a0fee23c4d70199d
BLAKE2b-256 9424677951fb7533f5ed35f703227f78b378e67b39c5aa05a24eacb901f82f42

See more details on using hashes here.

File details

Details for the file dynamic_cli_builder-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for dynamic_cli_builder-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0183ba390de00790613d4e795a9f91a27a2d3e549aafef99d79370445795e881
MD5 11b88f362b8d0dd5f3ebdabd56ec6008
BLAKE2b-256 1093d901bea77acd5d436dba0da94dba2472de416d2cd076c25bcb842a657ba1

See more details on using hashes here.

Supported by

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