Palm Interface Goals

[ethanknox-palmetto]

Palm could use a major leap in usability and insulation.

Things I think we want in an interface:

• completely insulate click
• "duplo" interfaces for common tasks

Here's some future api ideas

    make a new command `relink_stripe` that syncs the stripe development CLI RPC
    $ palm new command relink-stripe

    # .palm/cmd_relink_stripe.py
    
    from palm.runners import run_on_host, run_on_host_silently, run_in_container, execute_in_running_container
    from palm.containers import container_stack_up, container_stack_down, container_full_clean, container_restart
    from palm.decorators import command,  option, argument
    from palm.echo import echo, red_echo, green_echo, yellow_echo, spinner, bool_prompt

    @argument("timeout", help_text="time in seconds to wait for stripe rpc before failing")
    @option("-f", "--force", help_text="forces stripe to re-link, destroying current tokens") 
    @command
    def cmd_relink_stripe(ctx):
        echo("Re-linking stripe, please wait...")
        spinner.start()
        try:
            execute_in_running_container(ctx, "stripe-cli", ".stripe.sh relink")
        except NoContainerFound:
            red_echo("Stripe container not running. Starting stack...")
            try:
                container_stack_up(ctx)
            except AlreadyBoundPort:
                red_echo("Unable to start stack, port is bound.")
                if not bool_prompt("Clobber running containers and attempt again?"):
                     raise AbortPalm
                echo("Clobbering running containers...")
                container_clean()
                green_echo("Containers clobbered. Attempting to start stack....")
                container_stack_up()
           green_echo("Stack started")
           execute_in_running_container(ctx, "stripe-cli", ".stripe.sh relink")
       green_echo("Stripe is relinked.")

OR

we could introduce a class interface. That could be, honestly, pretty amazing.

    # .palm/cmd_relink_stripe.py
     
    from palm.commands import Command, Arg, Option
    from palm.exceptions import NoContainerFound, AlreadyBoundPort

    class RelinkStripe(Command):
        """ Relinks stripe CLI to the stripe dev RPC for local development."""

        # ordered list of argument objects made available with dot notation in self.params
        argset = [ Arg("timeout", help_text="time in seconds to wait for stripe rpc before failing") ]
        optionset = [Option(("-f", "--force", help_text="forces stripe to re-link, destroying current tokens") ]

        def run(self): 
              self.echo("Re-linking stripe, please wait...")
              self.spinner.start()
              self._attempt_in_stack_or_clobber()        

        def _attempt_in_stack_or_clobber(self):
             """Try to execute. if it fails, try to start the stack. if that fails, prompt to clobber"""
             try:
                 self.execute_in_running_container(".stripe.sh relink", service_name="stripe-cli")
            except NoContainerFound:
                red_echo("For some reason I want to print an arg here! {self.params.timeout}")
                # etc etc 

The amazing thing about a class implementation is that we can pass the context into the instance at runtime - so we make it available as self.context. But we could completely insulate the mechanics of how we are running things, letting us deal with as much podman / operating system / python BS was we want without bothering the user. This would give palm commands much longer shelf lives as the same command written originally for a docker / python3.6 / macOS env will live on in a podman / python4.0 / Redhat Linux dev env in 5 years.

It also lets us "duplo" stuff like self.run_on_host and self.run_on_host_silently which feels much more accessible than run_on_host(check=True, capture_output=True) to me. Sure we could support this style in a functional interface too.

What do y'all think?