README.md

Tim's cli utils,

this is to quickly build cli utils for managing a buch of relatively independent tasks.

the basic idea is that there are a few general '--' params and a buch of actions, every action parase its own params.

general syntax:

./script.py (-c context) [action] [params of action] (-a --b [args of action])

tasks an easily defined by adding the @register_action decorator

e.g.:

#!/usr/bin/env python3
import subprocess
from cliutils import *

@register_action(alias=["k8", "kubectl"], parse_own_args=True)
def autenticated_kubectl(args):
    subprocess.run(["kubectl", **args.unparsed, "-n", "default-namespace"], env={
        "KUBE_CONFIG" : "/this/projects/kube/config",
        "AUTH_DATA" : authprovider.get_auth()
    })

if __name__ == "__main__":
    parse_actions_run()

Now you can simply run ./script.py k8 get pods without switching kube context or namespace. You could e.g.: have a encryped database as authprovider and could simply require the password for that on every call.

Then you never have unencrypted credentials laying around.

Other skills

• ./script.py _help generates help message based on doc-string for actions
• ./script.py _null_subprocess this will supress all subproess calls and only print the commands
• Full action name and argument autocompletion ( optional for your own action if you provide choices )
• Generates readable overview of actions

generated action summary

(click!) ./script.py print_help --markdown-table

[action]	aliases	doc	parses own args
print_help	['?']		True
print_commands	['_null_subprocess']	Supress all output from subprocess. (run / check_output / call) AND only print the commands being executed	False
complete	['activate_completion']	I dont use argompletes global completion. This allowes you to simply dispatch into a bash session with completion enabled	False
kubectl	['k8']		False

example

see ./script.py