InteractiveArgparse

Table of Contents

• Installation
• Getting Started
• Usage
• Features
• Prompters
• Subcommands

Installation

To install, run

pip install InteractiveArgparse

Getting Started

You can wrap your existing ArgumentParser with an InteractiveArgumentParser like so:

import argparse
from interactive_argparse import InteractiveArgumentParser

def main():
    parser = argparse.ArgumentParser()
    parser.add_argument("--name", help="The user's name.")
    parser.add_argument("--should_greet", help="Whether or not I should greet the user", action="store_true")

    iparser = InteractiveArgumentParser(parser)
    args = iparser.parse_args()
    print(args)


if __name__ == "__main__":
    main()

Running this script without arguments results in interactive prompts like so:

Prompters

InteractiveArgumentParser can be pointed at a completely different interactive flow via its prompter argument: a rich-based terminal prompter (RichPrompter), an auto-generated web form (WebPrompter), or your own custom Prompter subclass.

from interactive_argparse import interactive


@interactive("rich")
def build_parser():
    parser = argparse.ArgumentParser()
    parser.add_argument("--name", help="The user's name.")
    return parser


args = build_parser().parse_args()

See docs/prompters.md for how to use the built-in prompters and how to write your own.

Subcommands

ArgumentParser.add_subparsers() is supported: InteractiveArgumentParser prompts for a subcommand first, then prompts for that subcommand's own arguments.

See docs/subparsers.md for details.

Development

Running tests

To run all tests:

python -m pytest

Contributing

We welcome early adopters and contributors to this project! See the Contributing section for details.

License

This project is open-sourced under the MIT license. See LICENSE for details.