dony 0.3.1

A lightweight Python command runner

🍥️ dony

A lightweight Python command runner with shell execution and user interactions.

Installation

pip install dony

Optional dependencies:

brew install fzf     # For fuzzy selection
brew install shfmt   # For shell command formatting

Example

import dony

@dony.command(run_from="git_root")
def deploy():
    """Deploy application"""

    if not dony.confirm("Deploy to production?"):
        return

    env = dony.select("Select environment:", ["staging", "production"])

    dony.shell("npm run build")
    dony.shell("npm test")
    dony.shell(f"./deploy.sh {env}", confirm=True)

    dony.success(f"Deployed to {env}")

if __name__ == "__main__":
    deploy()

Run with python deploy.py

Things to know

• Available directories to run from:
  • "current_dir" (default)
  • "git_root"
  • "command_file"
  • "temp_dir"
  • Custom path string
• Available prompts based on questionary:
  • dony.input(): free-text entry
  • dony.confirm(): yes/no ([Y/n] or [y/N])
  • dony.select(): option picker (supports fuzzy)
  • dony.select_many(): multiple option picker (supports fuzzy)
  • dony.press_any_key(): pause until keypress
  • dony.echo(): styled text output
  • dony.error(): ✕ error message
  • dony.success(): ✓ success message

API Reference

def command(
    run_from: Union[str, Path, Literal[ "current_dir", "git_root", "command_file", "temp_dir"]] = "current_dir",
    verbose: bool = True,
): 
    ...

# Shell execution
def dony.shell(
    command: str,
    run_from: Optional[Union[str, Path]] = None,
    dry_run: bool = False,
    quiet: bool = False,
    capture_output: bool = True,
    abort_on_failure: bool = True,
    abort_on_unset_variable: bool = True,
    trace_execution: bool = False,
    show_command: bool = True,
    confirm: bool = False,
) -> str:
    ...


## License

MIT License

## Author

Mark Lidenberg [[e-mail]](mailto:[e-mail])