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

Project details


Download files

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

Files for groom, version 0.0.1a1
Filename, size File type Python version Upload date Hashes
Filename, size groom-0.0.1a1-py3-none-any.whl (6.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size groom-0.0.1a1.tar.gz (5.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page