Skip to main content

Command Line Interface builder that helps creating an entry point for your application.

Project description

Clinner

Build Status codecov PyPI version

  • Version: 1.12.3
  • Status: Production/Stable
  • Author: José Antonio Perdiguero López

Clinner is a library that provides some useful tools to create command line interfaces for your application

Check Clinner docs.

Features

Can define commands in multiple way:

  • List of shell commands such as ["docker build", "docker push"].
  • Python functions.
  • Python async functions.

Clinner provides a set of commands ready to use like:

  • Black.
  • Flake8.
  • Isort.
  • Nosetest.
  • Prospector.
  • Pytest.
  • Sphinx.
  • Tox.

Hooks for injecting variables or add global arguments to your script.

Quick start

Install this package using pip:

pip install clinner

Create a command

from clinner.command import command

@command
def foo(*args, **kwargs):
    return True

Create a main file:

from clinner.run.main import Main

if __name__ == '__main__':
    sys.exit(Main().run())

Commands

Commands are declared using a decorator to register given functions. Commands are functions with the follow parameters:

  1. func: Function that will be called when command would be executed.
  2. command_type: Type of the command, could be a bash or python command.
  3. args: Parser arguments for this command.
  4. parser_opts: Command subparser's keywords, such as description.

This decorator allows to be used as a common decorator without arguments, where default type (python) will be used:

@command
def foobar(*args, **kwargs):
    pass

Or specifying the type:

@command(command_type=CommandType.PYTHON)
def foobar(*args, **kwargs):
    pass

But also is possible to provide command line arguments, as expected by argparse.ArgumentParser.add_argument:

@command(args=((('-f', '--foo'), {'help': 'Foo argument that does nothing'}),                   # Command argument
               (('--bar',), {'action': 'store_true', 'help': 'Bar argument stored as True'})),  # Another argument
         parser_opts={'title': 'foobar_command', 'help': 'Help for foobar_command'})            # Parser parameters
def foobar(*args, **kwargs):
    pass

All commands will be registered in a command register that can be accessed through command.register. Each entry in this register is a dictionary with the fields declared at the beginning of this section.

Shell command

Example of running ls -la shell command.

@command(command_type=CommandType.SHELL)
def lsla(*args, **kwargs):
    return [shlex.split("ls -la")]

Python function

Run a python function.

@command
def foo(*args, **kwargs):
    return "foo"

Python async function

Run a python async function.

@command
async def bar(*args, **kwargs):
    await asyncio.sleep(1)
    return "bar"

Main

A main class is defined to ease the creation of command line applications. This class follows the process:

  1. Create a parser using argparse.ArgumentParser for the application:

    a) Calling all add_arguments(parser) methods from all super classes, e.g: clinner.mixins.HealthCheckMixin.

    b) Addding a subparser for each command with their specific arguments.

  2. Parse arguments using the argument parser created previously.

  3. Inject variables into environment calling all super classes methods whose name starts with inject_.

Examples

Some Clinner examples.

Simple Main

Example of a simple main with two defined commands foo and bar.

#!/usr/bin/env python
import shlex
import sys

from clinner.command import command, Type as CommandType
from clinner.run.main import Main


@command(command_type=CommandType.SHELL,
         args=(('-i', '--input'),
               ('-o', '--output')),
         parser_opts={'help': 'Foo command'})
def foo(*args, **kwargs):
    """List of foo commands"""
    ls_cmd = shlex.split('ls')
    wc_cmd = shlex.split('wc')
    wc_cmd += [kwargs['input'], kwargs['output']]

    return [ls_cmd, wc_cmd]


@command(command_type=CommandType.PYTHON,
         parser_opts={'help': 'Bar command'})
def bar(*args, **kwargs):
    """Do a bar."""
    return True


if __name__ == '__main__':
    sys.exit(Main().run())

Builder Main

Example of main module with build utilities such as unit tests, lint, sphinx doc, tox and dist packaging:

#!/usr/bin/env python
import sys

from clinner.run import Main


class Build(Main):
    commands = (
        'clinner.run.commands.black.black',
        'clinner.run.commands.flake8.flake8',
        'clinner.run.commands.isort.isort',
        'clinner.run.commands.pytest.pytest',
        'clinner.run.commands.sphinx.sphinx',
        'clinner.run.commands.tox.tox',
    )


if __name__ == '__main__':
    sys.exit(Build().run())

Check Clinner docs to see more advanced examples.

Project details


Release history Release notifications

This version
History Node

1.12.3

History Node

1.12.2

History Node

1.12.1

History Node

1.12.0

History Node

1.11.1

History Node

1.10.0

History Node

1.9.4

History Node

1.9.3

History Node

1.9.2

History Node

1.9.1

History Node

1.9.0

History Node

1.8.2

History Node

1.8.1

History Node

1.8.0

History Node

1.7.0

History Node

1.6.2

History Node

1.6.1

History Node

1.6.0

History Node

1.5.0

History Node

1.4.2

History Node

1.4.1

History Node

1.4.0

History Node

1.3.1

History Node

1.3.0

History Node

1.2.0

History Node

1.1.1

History Node

1.1.0

History Node

1.0.2

History Node

1.0.0

History Node

0.5.2

History Node

0.5.1

History Node

0.5.0

History Node

0.4.2

History Node

0.4.1

History Node

0.4.0

History Node

0.3.2

History Node

0.3.0

History Node

0.2.0

History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
clinner-1.12.3-py3-none-any.whl (75.4 kB) Copy SHA256 hash SHA256 Wheel py3 Jul 18, 2018
clinner-1.12.3.tar.gz (26.4 kB) Copy SHA256 hash SHA256 Source None Jul 18, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page