Skip to main content

Declic (DEcorator-oriented CLI Creator) is a tiny Python 3 package for creating command line interfaces using decorators. It was inspired by the click package and is based on argparse

Project description

Declic (DEcorator-oriented CLI Creator) is a tiny Python 3 package for creating command line interfaces using decorators. It was inspired by the click package and is based on argparse

Installation

From PyPI:

pip install declic

or from Github:

pip install git+https://github.com/Septaris/declic.git

Usage

Here is an example of Declic usage:

from declic import group, argument, command


@group(description='my description')
@argument('--version', action='version', version='<the version>')
@argument('--foo', type=int, default=1)
def bar():
    print('bar')

@bar.group(invokable=True)
@argument('--toto', type=int, default=2)
@argument('--tata', type=str, default='aaa')
def sub_group(toto, tata):
    print(toto)
    print(tata)

@sub_group.command(chain=True)
def mop(toto, **kwargs):
    print(kwargs)
    print(toto)

@bar.command()
@argument('-x', type=int, default=1)
@argument('y', type=float)
def foo(x, y):
    print(x, y)


if __name__ == '__main__':
    import sys

    bar(sys.argv[1:])
    # or bar()

Running the cli:

$ python my_file.py --help

usage: bar [-h] [--foo FOO] [--version] {sub_group,foo} ...

my description

positional arguments:
  {sub_group,foo}

optional arguments:
  -h, --help       show this help message and exit
  --foo FOO
  --version        show program's version number and exit

Project details


Download files

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

Source Distribution

declic-1.0.1.tar.gz (4.1 kB view hashes)

Uploaded Source

Built Distribution

declic-1.0.1-py3-none-any.whl (4.1 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