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: say_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 --name world

You should see

Hello World!

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.10.tar.gz (3.3 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.10-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dynamic_cli_builder-0.1.10.tar.gz
Algorithm Hash digest
SHA256 936ab40732c8bf8f3589451414390c7cab0a76bfbe5aeda29a454ae833d54795
MD5 c773f7c1cd06f2ff1e8ed78e7ee638a4
BLAKE2b-256 385c82ea9441f52f61d71bea2fd622b47617072973320bfeeea998f05a8f1726

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dynamic_cli_builder-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 4707e3c2ae1313751373566696d0ddc33bb801509a514341a19dbc430f40b744
MD5 41b00e8533782b95b030a380d8e73e31
BLAKE2b-256 0b096426a864ef56bc0c7390dcefa355612c7ab28622e406fb8b921c8ee0f750

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