simplecmdinterface 0.3.0

A simple windows command line interface wrapper for use with cli's

CmdInterface Class Documentation

Overview

The CmdInterface class provides a robust Python interface for interacting with command-line processes in Windows. It is designed to encapsulate command sending and output handling of a single terminal into a simple and clean API that can be easily integrated into larger applications.

Features

• Live Context: Changes in the terminal context by a command persist and the terminal is kept alive.
• Multiple Instances: Launching Multiple Instances at the same time does not create interference.
• Command Isolation: Ensures that commands sent through the interface are not executed at the same time if sent to the same instance, and outputs are cleanly separated.
• Boilerplate Removal: Automatically handles removal of unnecessary startup text from command outputs.
• Logging Capability: Offers optional logging of all commands and outputs for debugging and auditing purposes.
• Safe Cleanup: Automatically manages subprocess termination to prevent resource leaks.

Usage

Instantiation

Create an instance of the CmdInterface with optional configurations:

from cmdinterface.CmdInterface import CmdInterface

cmd = CmdInterface(nude=True, rm_boilerplate=True, end_signal="END_OF_OUTPUT", log_mode=False)

# Send commands and capture outputs
output_hello_world = cmd.send_command( "echo Hello, World!")
output_dir = cmd.send_command( "dir")
output_dir2 = cmd.send_command( "cd ..")
output_dir3 = cmd.send_command("dir")

# Output results
print("Output of 'Hello, World!':", ''.join(output_hello_world))
print("Output of 'dir':", ''.join(output_dir))
print("Output of 'dir2':", ''.join(output_dir2))
print("Output of 'dir3':", ''.join(output_dir3))