cloc 0.1.0

Command Line Object Chaining (cloc) - Modern cli framework for simple and complex cli applications

Command Line Object Chaining - cloc

Modern cli framework for simple and complex cli applications

ToC

• Requirements
• Installation
• Information
• Examples
  
  

Requirements

• System

  • Python 3.6+

• Python Pip

  • requests
    
    

Installation

Virtual Environment is recommended

$ git clone https://www.github.com/tannerburns/cloc
$ cd cloc
$ pip3 install .

Information

Command line framework for making simple and complex command line applications.

• Easily group commands together
• Connect commands with classes for querysets
• Create command line viewsets for abstracting user interaction on command querysets
  
  

Examples

from cloc import cmd, grp, opt
from cloc.types import IntRange

@grp('cli')
def cli():
    """base cli"""
    pass

@cmd('hello')
@opt('--count', '-c', type=IntRange, default=1, help='Number of greetings: ex -c 0,5 OR -c 5')
@opt('--name', '-n', type=str, help='The person to greet')
def hello(count: IntRange, name: str):
    """Simple program that greets NAME for a total of COUNT times."""
    for _ in count:
        print(f'Hello {name!r}')

if __name__ == '__main__':
    cli.add_command(hello)
    cli()