py-bash-wrapper 0.3.9

Simplify the use of Bash/Shell commands in Python

Py-Bash-Wrapper

Description

Py Bash Wrapper helps Python developers run bash/shell/subprocess commands with two convenience functions:

• The run_command function provides no advances shell features likes pipes. This function takes in either a string or an argv list.
• The run_bash function provides real Bash (e.g., pipes, redirects, globs, etc.). This function takes in a string.
• Both functions support optional real-time streaming callbacks and file-object stdout/stderr passthrough for long-running operations.

Results come back as CommandResult with stdout, stderr, exit code, and an ok flag; The argument check=True will cause failures to raise a CommandError.

Installation

From PyPI:

pip install py_bash_wrapper

Documentation

• Usage examples -- safe patterns, run_command vs. run_bash, errors and post-checks.
• Project structure -- where code, tests, and automation live.
• Code style -- Ruff, Mypy, pytest, and conventions.
• Maintainers -- versions, CI, releases, security notes for shell APIs.
• Plan / roadmap -- upcoming tasks.

Security note

run_bash executes shell code. Do not pass untrusted input as the Bash command string. Prefer run_command with a fixed argv when shell features are not required. See docs/usage_examples.md.

Initial setup

Prerequisites:

• uv (package and tool runner):
  • macOS: brew install uv (see Homebrew if needed).
  • Other: Installing uv (official installer and package managers).
• make:
  • macOS: Xcode Command Line Tools or a build toolchain that provides make.
  • Linux: install build-essential.
  • Windows: use Git Bash, WSL, or another environment that provides make, or run the same uv run ... commands from the Makefile by hand.
• Python 3.11+: install via OS package manager, via uv with uv python install 3.11, or via python.org.

Versioning

Releases follow SemVer.