magicli 2.1.5

Automatically generates a CLI from functions.

magiᴄʟɪ✨

Automatically turns a file into a CLI without any boilerplate by introspecting its functions.

hello world example

# hello.py
def hello(name, greeting="hello"):
    print(greeting, name)

becomes

with only 3 commands

1. pip install magicli
2. magicli
3. pip install .

Quick start

Install magicli

pip install magicli

Setup your repository

Initialize repo

git init

Add version info (optional)

git tag 1.0.0

Automatically create CLI

magicli

Make sure the name of your CLI, the module name and the name of the function have to same name.

Install your Python package

pip install .

Advanced use

Using subcommands

# module.py
def hello(): ...

def world(times=1):
    for _ in range(times):
        print("hello world")

$ hello world --times 2
hello world
hello world

Help message

By default, the docstring of the function will be displayed.

If no docstring is specified, an error message will be printed.

Development

Run pytest with coverage report:

python3 -m pytest -s --cov=magicli --cov-report=term-missing