Skip to main content

Bash replacement library for Python

Project description

minishell

An idiot admires complexity, a genius admires simplicity

©️ Legend Terry A. Davis

I want to ditch Bash and replace all use cases of it with Python. I recently learned that there's no good alternative for Bash. You can argue that there is, but then compare what they can write in Bash and how unreadable it becomes with any of the traditional shell solutions out there.

Goals

  • minishell is going to be extremely simple
  • Compete with Bash only
  • Do not add features just because other libraries have them
  • Stay focused: execute commands and parse arguments, nothing more

Philosophy

Bash works because it's the shell. You can't replicate that. But you can make Python script writing as painless as Bash for everything else: better error handling, better argument parsing, better readability.

minishell provides just what you need:

  • shell(cmd, *args) - Run commands with full TTY support and optional argument escaping
  • shell[cmd, *args] - Same as previous, but capture output
  • shell.args[1], shell.args.named_argument - Parse CLI arguments automatically

That's it. No frameworks, no magic.

Quick Start

# Raw command
shell("ls -la | grep test")

# With escaped arguments (safe!)
filename = "file with spaces.txt"
shell("rm {}", filename)

# Capture output
output = shell["pwd"]
print("Current dir:", output)

# Arguments are auto-parsed
app_name = shell.args.app_name
if not app_name:
    shell.exit("Error: --app-name required")

API

shell(cmd, *args)

Execute a command with optional argument escaping.

  • cmd: Command string with optional {} placeholders
  • args: Arguments to format and escape
  • Returns exit code
shell("echo hello")           # raw
shell("echo {}", "hello")     # with escaping

shell[cmd, *args]

Execute command and capture output. Returns the output string.

output = shell["pwd"]
# With escaped arguments
output = shell["find {} -name {}", "/path", "*.py"]

shell.read(cmd, *args, exit_on_error=False)

Execute command and capture output with more control.

  • Returns tuple[output, exit_code]
  • Set exit_on_error=True to exit on non-zero code (usually it's better to use shell[cmd, *args])
output, code = shell.read("ls")
output, code = shell.read("find {} -name {}", "/path", "*.py", exit_on_error=True)

shell.args

Automatically parsed command-line arguments.

# Positional
print(shell.args[0])

# Named arguments
print(shell.args.config)
print(shell.args.verbose)

# Multiple values become lists
if isinstance(shell.args.file, list):
    for f in shell.args.file:
        print(f)

Installation

pip install minishell

Or just copy minishell.py to your project.

Why not Bash?

Feature Bash minishell
Argument parsing 50+ lines 3 lines
Variable syntax $VAR, ${VAR} f-strings
Error handling set -e (fragile) Explicit
Type hints None Full typing
Readability Medium High

Contributing

We need Bash specialists to provide code examples that are:

  • Cleaner/simpler in Bash than in Python with minishell
  • Real-world use cases we should optimize for

Alternatively, suggest improvements to keep the library minimal and focused. Pure critique without suggestions is also appreciated!

The bar for adding features: Does this save significant boilerplate compared to Bash?

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

minishell-2.0.14.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

minishell-2.0.14-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file minishell-2.0.14.tar.gz.

File metadata

  • Download URL: minishell-2.0.14.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for minishell-2.0.14.tar.gz
Algorithm Hash digest
SHA256 c042bee992ab25929da35f221efe92766427900991ff70b6a8af943b6f6da388
MD5 d010802c070eeb4642f25e492d78f591
BLAKE2b-256 e025f167435a94fb453ddf53d0908d1455abec7b25244933250b54fdce44b554

See more details on using hashes here.

File details

Details for the file minishell-2.0.14-py3-none-any.whl.

File metadata

  • Download URL: minishell-2.0.14-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for minishell-2.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 7223e98f797579ad8df40e8067ed2130c183b6f626b29a7637369e17f47193df
MD5 8a1d6abd747626ccfd572d95e516c873
BLAKE2b-256 a6a17cf021e4abb156181014f647f526d6d5936280abd453e2dcd6267e9d76ec

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page