argbind

What it is and what it does

ArgBind is a lightweight CLI framework that generates command-line interfaces and configuration file support directly from Python function signatures and docstrings. Instead of writing separate argument parsers, you decorate functions with @argbind.bind(), and ArgBind automatically exposes their arguments as CLI flags (using a function.argument naming pattern) and loads them from YAML files. It depends on pyyaml for file I/O and docstring-parser to extract parameter documentation.

The package is designed for nested, scoped configuration—particularly useful in machine learning workflows where you might run the same function in different contexts (e.g., train vs. test scope) with different arguments. You can save execution configurations to YAML, reload them to reproduce runs, and override individual arguments from the command line. The entire library is intentionally small (~400 lines) and requires no external CLI framework, making it a minimal alternative to argparse for projects that value docstring-driven interfaces and YAML-based reproducibility.

Use it for

• Configure ML experiments with nested YAML files and reproduce runs by loading saved configurations.
• Build multi-stage CLI programs where functions run in different scopes (train/test/eval) with scope-specific arguments.
• Migrate from argparse scripts without rewriting argument logic—bind existing functions and let ArgBind generate the CLI.
• Run the same function from CLI, Python scripts, and Jupyter notebooks using the same argument binding mechanism.
• Save and version experiment configurations as YAML for audit trails and easy parameter sweeps.

Worth the install?

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

Install

argbind on PyPI

Before you install

Installation requires downloading from source (high friction). The package is dormant—last commit was 2024-08-11 with no releases since 2024-05-24, and it depends on pyyaml and docstring-parser, both stable libraries. Suitable for projects where maintenance lag is acceptable.

License in practice

Licensed under MIT (permissive), allowing unrestricted use, modification, and distribution in both open and closed projects with minimal obligations.

Quickstart

pip install argbind

import argbind

@argbind.bind()
def hello(name: str = 'world'):
    """Say hello.
    Parameters
    ----------
    name : str, optional
        Who to greet, by default 'world'
    """
    print(f"Hello {name}")

if __name__ == "__main__":
    args = argbind.parse_args()
    with argbind.scope(args):
        hello()

Package facts

Evidence: argbind-0.3.9.tar.gz

Tags

More Application Frameworks packages

See also ConfigArgParse · clize · targ · argparse · typed-argument-parser · autocommand · python-gflags · entrypoint2 · pydantic-argparse · multimethod