InteractiveArgparse 0.1.0

Effortlessly turn any ArgumentParser script into an interactive prompt.

InteractiveArgparse

Table of Contents

• Installation
• Getting Started
• Usage
• Features
• Prompters

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

Terminal prompts are just the default — InteractiveArgumentParser can be pointed at a completely different interactive flow via its prompter argument, including an auto-generated web form (WebPrompter) or your own custom Prompter subclass.

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

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.