gripe 2024.2.12.22.43

Shell helper utilities for python

gripe
	Shell-util library for python. Includes helpers for subprocess invocation, shell-formatters / pretty-printers, and more.

---

• Overview
• Features
  • Shell-formatters / pretty-printers
  • Subprocess Invocation
• Installation
• Usage (CLI)
• Usage (API)
  • OOP-style Dispatch
  • Loading data when command-output is JSON

---

Overview

The gripe library provides various shell-utilities for python.

---

Features

Shell-formatters / pretty-printers

• A somewhat usable parser / grammar for bash
• Console support for rich & rich protocols

Subprocess Invocation

There's a lot of shell-related libraries out there, especially for invocation (see for example this list). The interface for gripe is hopefully unsurprising, and something that's convenient but not fancy. It's a utility, and not a huge framework.

The main goal is to provide an API that is simple and stable, without a ton of dependencies.

>>> import gripe 
>>> proc = gripe.invoke('echo hello world')
>>> assert proc.succeeded
>>> assert proc.stdout.strip()=='hello world'
>>>

Beyond such basics, gripe includes support for rich output and uses pydantic for datastructures.

See the API docs for more detailed information.

---

Installation

See pypi for available releases.

$ pip install gripe

---

Usage (CLI)

The gripe library publishes a small CLI tool, mostly just for testing & demoing the API behaviour. See the CLI docs for the latest (autogenerated) help.

---

Usage (API)

See also:

• the unit-tests for some examples of library usage
• the smoke-tests for example usage of stand-alone scripts

OOP-style Dispatch

This uses gripe.Invocation and returns gripe.InvocationResponse.

>>> import gripe 

Loading data when command-output is JSON

>>> import gripe 
>>>