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: greet_user

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.4.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.4-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dynamic_cli_builder-0.1.4.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.4.tar.gz
Algorithm Hash digest
SHA256 22fcf031d2b9a13e74bc88965da06aed56fea787263b0baf6ef9b3191141c8b4
MD5 2dc26346921da9e6f28fdd03035ec4bf
BLAKE2b-256 941c7c85f78430694f7d49d69c483ce7c310fc041343ad4437d0b9aeefb48b3a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dynamic_cli_builder-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9a7ded6cf3d6a8fdb4085f42f5af86b369a7397a2e8f3a748e5b5225e92adf4f
MD5 67cc89b8ad56df5c1287ccf21020ff2c
BLAKE2b-256 2b54f3287cd58d56590f683a1a813aab02c0e865baed07faf29b0dba99a21eea

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