upycli 0.1.0

A microscopic library to turn any function into a CLI.

uPyCLI

A microscopic library to turn any function into a CLI.

Takes some inspiration from pycli although I didn't know this existed before starting. This lib is even smaller than pycli and does not require any setup and has no dependencies.

Usage

cli path.to.your.function --help

For this to work, all you need to do is have a function in the module with the right type-annotations and all optional values should have a default value.

# Here model_name is required and data_path is optional
def train(
        model_name: str, 
        data_path: str = "./path/to/data"):
    ...

Alternatively, the command decorator can be used to directly turn the function into a CLI command

# main.py
from upycli.decorator import command

@command
def train(
        model_name: str, 
        data_path: str = "./path/to/data"):
    ...

python main.py train --help
>>> usage: main.py [-h] --model_name MODEL_NAME [--data_path DATA_PATH]

options:
  -h, --help               show this help message and exit
  --model_name MODEL_NAME  str
  --data_path DATA_PATH    str (default ./path/to/data)