python-scripttease/help/en/docs/how-to/use-with-commonkit.md

Use Script Tease With Common Kit

Since the focus of Script Tease is to convert plain text instructions into valid command line statements, it does not provide support for executing those statements either locally or remotely. However, the shell component of python-commonkit does provide support for executing commands in local POSIX environments.

Here is an example of how to use these packages together:

from commonkit.shell import Command
from scripttease.exceptions import InvalidInput
from scripttease.lib.factories import command_factory
from scripttease.lib.loaders import INILoader

def execute(step):
    command = Command(
        step.statement,
        comment=step.comment,
        path=step.cd,
        prefix=step.prefix,
        shell=step.shell
    )

    # Sudo is a different class, but identical in behavior.
    command.sudo = step.sudo

    if command.run():
        print("[success] %s" % step.comment)
    else:
        print("[failure] %s" % step.comment)
        if step.stop:
            print("I can't go on: %s" % command.error)
            exit(command.code)


ini = INILoader("path/to/steps.ini")
ini.load()

try:
    steps = command_factory(ini)
except InvalidInput as e:
    print("%s: I can't go on." % e)
    exit(1)

# A failure to load results in None.
if steps is None:
    print("Failed to load steps. Bummer.")
    exit(1)

# Iterate through each step to create a Common Kit command instance.
for step in steps:

    # To preview ...
    # print(step.get_statement(cd=True))
    execute(step)

Common Kit is already a dependency of Script Tease, so it is installed by default. The execute() function provides the interface between Script Tease command instances and Common Kit command instances.