Skip to main content

A easy-to-use command-line interface generator

Project description

A easy-to-use command-line interface generator

introduction

Have you never wanted to create cli tools with python more easily? Groom brings you easier way to create cli tools.

Here is an example:

from groom import *

def function(*,
  first_arg: positional(
    int,
    'int value',
    required=True,
    var_name='INT'),
  second_arg: switch(
    'switch value',
    short_name='s'),
  third_arg: optional(
    str,
    'string value',
    short_name='t') = 'string',
  fourth_arg: multiple(
    float,
    'list of float values',
    short_name='f') = [0.1, 3.2]):
  print('first_arg:', first_arg)
  print('second_arg:', second_arg)
  print('third_arg:', third_arg)
  print('fourth_arg:', fourth_arg)

if __name__ == '__main__':
  Dispatcher(
    function,
    "A test command-line program"
  ).dispatch()

This supports int, str, float, complex, and bool as a parameter type. If you passed other types, it will throw TypeError.

Features

Groom has those features:

  • default values

  • list parameters

  • automatic help generation

  • sub-command support

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

groom-0.0.3a1.tar.gz (6.0 kB view hashes)

Uploaded Source

Built Distribution

groom-0.0.3a1-py3-none-any.whl (7.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page