magicli 1.0.0

Automatically generates a CLI from functions.

magiᴄʟɪ✨

Automatically generates a CLI from functions.

Install

pip install magicli

Get started

Simple usage example.

# module.py
def hello(name, times=1):
    for _ in range(times):
        print("hello", name)

import magicli

Make sure you import magicli at the end of the file.

$ python3 module.py world --times 2
hello world
hello world

Define name of CLI in pyproject.toml

Add the following to your pyproject.toml.

[project.scripts]
hello = "module:hello"

This example assumes the following project structure with the CLI to be created specified in the file module.py.

.
├── module.py
└── pyproject.toml

You can now pip install your code and call it like this:

$ hello world --times 2
hello world
hello world

Make sure to adjust the path to module if your project layout is different.

Using subcommands

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

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

import magicli

$ 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, there will be no output.