UniversalWrapper 1.4

No project description provided

UniversalWrapper

Use any shell command in python conveniently.

Based on subprocess, the universal wrapper provides an intuitive wrapper around any cli. Tested on ubuntu only. The development is inspired by my jealousy toward bash scripts, where command line tools can be integrated seamlessly into the code. This tool provides a similar level of integration, without having to manually write wappers for the specific cli’s.

Getting started

pip install UniversalWrapper

Usage

UniversalWrapper uses a set of simple rules to convert python commands to bash commands:

from universalwrapper import uw_example
uw_example.run.command("foo", bar="bar", b="foo", foo_bar=True)
# calls $ uw-example run command foo --bar bar -b foo --foo-bar

The default conversion rules are: - “_” is changed to “-” (see uw_settings.divider and uw_settings.flag_divider) - between classes (the .) a space is added (see uw_settings.class_divider) - A argument is converted to a string - Keyword arguments are converted to flags, if arg=True, only the flag is use (no arguments) if arg=False the flag is removed if it is present in uw_settings.input_add - Keyword arguments with list repeat the flag: foo=['bar', 'bar'] calls --foo bar --foo bar

If you don’t want to import every single command, use:

import universalwrapper as uw

uw.example("foo", "bar")
# calls $ example foo bar

Repetitive commands or output modifications can be set uw_settings, see advanced usage. # Examples ## Example: create and delete lxd containers

from universalwrapper import lxc

lxc.launch("ubuntu:20.04", "testcontainer")
# calls $ lxc launch ubuntu:20.04 testcontainer

lxc.delete("testcontainer", force=True)
# calls $ lxc delete testcontainer --force

Example: clone a library

from universalwrapper import git

git.clone("https://github.com/Basdbruijne/UniversalWrapper.git")
# calls $ git clone https://github.com/Basdbruijne/UniversalWrapper.git

check git diff files:

diff = git.diff(name_only=True)
# calls $ git diff --name-only

True and False flags are not forwarded to the cli. Instead True will add the flag only (without arguments) and False will remove the flag in case it is present elsewhere in the command. The latter can be useful is input overrides are used (see advanced usage). To avoid this behaviour, pass True or False as strings.

Example: send a notification

from universalwrapper import notify_send

notify_send("title", "subtitle", i="face-wink")
# calls $ notify-sed title subtitle -i face-wink

The argument (root=True) will trigger sudo in the command.

Advanced usage

The universal wrapper does not have any functions build in that are made for one specific cli. If there are repetitive modifications to commands that need to be made, this can be done by editing the uw_settings:

from universalwrapper import lxc

lxc.uw_settings
>>
lxc.uw_settings.cmd: str # base command
lxc.uw_settings.divider: str = '-' # string to replace '_' with in command
lxc.uw_settings.class_divider: str = ' ' # string to put between classes
lxc.uw_settings.flag_divider: str = '-' # string to replace '_' with in flags
lxc.uw_settings.debug: bool = False # if True, don't execute command but just print it
lxc.uw_settings.input_add: dict: {str: int, str: int} = {} # {extra command, index where to add it}
lxc.uw_settings.input_move: dict: {str: int, str: int} = {} # {extra command, index where to move it to}
lxc.uw_settings.input_custom: list[str] # custom command: e.g. "command.reverse()"
lxc.uw_settings.output_decode: bool = True, # Decode output to str
lxc.uw_settings.output_splitlines: bool = False, # Split output lines into list
lxc.uw_settings.output_yaml: bool = False, # Try to parse yaml from output
lxc.uw_settings.output_json: bool = False, # Try to parse json from output
lxc.uw_settings.output_custom: list[str] # custom command: e.g. "output.reverse()"