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, **kwargs) - Run commands with full TTY support and optional argument escaping
  • shell[cmd, *args, **kwargs] - 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")

Main API

There are more things, but you may need to read source code.

shell(cmd, *args, **kwargs)

Execute a command with optional argument escaping.

  • cmd: Command string with optional {} placeholders
  • args: Positional arguments to format and escape
  • kwargs: Named arguments to format and escape
# raw
shell("echo hello")
# positional escaping
shell("echo {}", "hello")
# named escaping
shell("git commit -m {message}", message="Fix#147")

shell[cmd, *args]

Execute command and capture output. Returns the output string.

  • cmd: Command string with optional {} placeholders
  • args: Positional arguments to format and escape
output = shell["pwd"]
# With escaped arguments
output = shell["find {} -name {}", "/path", "*.py"]

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.15.tar.gz (5.6 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.15-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: minishell-2.0.15.tar.gz
  • Upload date:
  • Size: 5.6 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.15.tar.gz
Algorithm Hash digest
SHA256 d6dbfe4d6ed575b61148e01cdee7fbb9dee6dfd86d53d47ed5ebe7766a394906
MD5 7a151d3c96bd798bad76e9658cf9756f
BLAKE2b-256 0e4782267965a982ac2005197fbf3a99789db641829c8582cff22a08e739a953

See more details on using hashes here.

File details

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

File metadata

  • Download URL: minishell-2.0.15-py3-none-any.whl
  • Upload date:
  • Size: 6.5 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.15-py3-none-any.whl
Algorithm Hash digest
SHA256 1848f1bd78009119d553b8c0fedad0d85ae28864fa85802293c20fb4a0c056cc
MD5 e18c0bce303a899f43841001c7b813c5
BLAKE2b-256 2bb62f01573e4d8ac9278b07f5672cfdba56709713a95473d6219947c33ed9b0

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