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.17.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.17-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: minishell-2.0.17.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.17.tar.gz
Algorithm Hash digest
SHA256 0910b8a42c0643eca18ba4acb1a78f392f999a8269c61b6b2ff9b200659e40f2
MD5 8ca2862c90a432546c9a0116e82feede
BLAKE2b-256 68ca14b6ce80bceb1a0d3d15bd54cbff58e6da642af557dfaf4cdfb18e2eef2b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: minishell-2.0.17-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.17-py3-none-any.whl
Algorithm Hash digest
SHA256 c44110149b8264dace2f46879b0867c674f7e9ec29bc9f59a453a925dc188581
MD5 8625f31dd072b834d0ba0969b42cd71f
BLAKE2b-256 28d69f9e0f9c27a66320f08ce26c9fcee9a59383c972439152a44c29d91a66f2

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