arguably

What it is and what it does

arguably is a Python CLI framework that generates command-line interfaces directly from function definitions and docstrings. Instead of writing separate argument parsing code, you decorate functions with @arguably.command, and arguably automatically builds a CLI that mirrors the function signature—required arguments become positional, defaults become optional, and keyword-only arguments become options. It parses docstrings in multiple formats (reStructuredText, Google, Numpydoc, Epydoc) to populate help text, and uses type annotations to handle automatic conversion of arguments to the correct types, including support for enums, lists, tuples, and custom objects.

The package is built on argparse and depends only on docstring-parser for docstring extraction. It supports nested subcommands via function naming conventions (e.g., s3__ls becomes s3 ls), and can also be invoked without any code integration via python3 -m arguably on an existing script. It's designed for developers who want CLI functionality with minimal boilerplate and no need to learn a separate DSL.

Use it for

• Quickly add a CLI to a script without writing argparse boilerplate or separate help text.
• Build multi-level command hierarchies (e.g., git-like subcommands) using only function naming.
• Convert a library of utility functions into a command-line tool with automatic help generation.
• Generate a CLI from an existing Python script using python3 -m arguably without modifying the source.
• Accept complex structured input (objects, enums, lists) from the command line with automatic type conversion.

Worth the install?

AI-flagged interpretation of the facts on this page. Verify before relying on it.

Install

arguably on PyPI

Before you install

Low friction—pure Python wheel with a single runtime dependency (docstring-parser). Maintenance is dormant: last release was 2024-05-10, though the repository remains active and the package supports current Python versions (3.9–3.12).

Requires Python 3.9 or later.

License in practice

License status is unclear—no SPDX identifier or raw license text is recorded. Verify the actual license before using in proprietary or restricted contexts.

Quickstart

pip install arguably

import arguably

@arguably.command
def greet(name: str, greeting: str = "Hello"):
    """Greet someone.
    
    Args:
        name: person to greet
        greeting: greeting to use
    """
    print(f"{greeting}, {name}!")

if __name__ == "__main__":
    arguably.run()

Package facts

Evidence: arguably-1.3.0-py3-none-any.whl

Tags

More Software Development packages

See also targ · autocommand · entrypoint2 · clize · argparse-dataclass · argdantic · pydantic-argparse · makefun · docopt-ng