magicli 2.2.0

Automatically generates a CLI from functions.

magiᴄʟɪ✨

magicli

automatically turns a file into a CLI by introspecting its functions.

• no boilerplate
• automatic help message
• type casting included
• supports sub-commands
• complete pyproject.toml setup
• ready for upload to pypi

Create a full CLI in only 2 lines of code:

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

calling magicli creates this CLI:

(animated terminal created with clivio)

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 .

or after uploading to pypi:

pip install <package_name>

Advanced use

Using subcommands

# hello.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