knack 0.2.0

A Command-Line Interface framework

Knack

---

 _                     _
| | ___ __   __ _  ___| | __
| |/ / '_ \ / _` |/ __| |/ /
|   <| | | | (_| | (__|   <
|_|\_\_| |_|\__,_|\___|_|\_\

A Command-Line Interface framework

pip install knack

Usage

from knack import CLI, CLICommandsLoader, CLICommand

def abc_list(myarg):
    import string
    return list(string.ascii_lowercase)

class MyCommandsLoader(CLICommandsLoader):
    def load_command_table(self, args):
        with CommandSuperGroup(__name__, self, '__main__#{}') as sg:
            with sg.group('abc') as g:
                g.command('list', 'abc_list')
        return OrderedDict(self.command_table)

    def load_arguments(self, command):
        with ArgumentsContext(self, 'abc list') as ac:
            ac.argument('myarg', type=int, default=100)
        super(MyCommandsLoader, self).load_arguments(command)

mycli = CLI(cli_name='mycli', commands_loader_cls=MyCommandsLoader)
exit_code = mycli.invoke(sys.argv[1:])
sys.exit(exit_code)

More samples and snippets available at examples.

Documentation

Documentation is available at docs.

Developer Setup

In a virtual environment, install the requirements.txt file.

pip install -r requirements.txt
pip install -e .

Contribute Code

This project has adopted the Microsoft Open Source Code of Conduct.

For more information see the Code of Conduct FAQ or contact [e-mail] with any additional questions or comments.

If you would like to become an active contributor to this project please follow the instructions provided in Contribution License Agreement

License

Knack is licensed under MIT.

Release History

0.2.0 (2017-09-27)

• Support command level and argument level validators.

• knack.commands.CLICommandsLoader now accepts a command_cls argument so you can provide your own CLICommand class.

• logging: make determine_verbose_level private method.

• Allow overriding of NAMED_ARGUMENTS

• Only pass valid argparse kwargs to argparse.ArgumentParser.add_argument and ignore the rest

• logging: make determine_verbose_level private method

• Remove cli_command, register_cli_argument, register_extra_cli_argument as ways to register commands and arguments.

0.1.1 (2017-07-05)

• Add more types of command and argument loaders.

• Add tests.

0.1.0 (2017-06-16)

• Initial release