mattdodge / shellshock

Write and test your shell scripts using Python

Write and test your shell scripts using Python

---

Shell scripts are great - they run on most *nix machines, they allow you interact with the file system easily, and they are light weight and don't require a massive runtime. However, the syntax is error prone and they are difficult to manage and test. Shellshock lets you write and test your shell scripts using the Python syntax and test cases you already know and love.

Installation

Writing with Shellshock requires Python. The shell scripts it outputs do not require Python to run though.

pip install shellshock

Usage

To convert a Python shellshock script to a regular shell script:

shellshock my_script.py -o my_script.sh

That command would, for example, turn this Python script: my_script.py

myvar = 5
if myvar > 3:
    print("Big number")
else:
    print("Small number")

into this shell script: my_script.sh

#!/bin/sh
myvar=5
if [ "$myvar" -gt 3 ]; then
  echo -e 'Big number'
else
  echo -e 'Small number'
fi

Starting with an existing shell script

Let's say you have an existing shell script you want to convert that looks like this:

oldscript.sh

if [ -f "file" ]; then
  echo "ok"
fi

You can easily make this a shellshock script using the ss.shell method and a multiline string at the top of the file:

oldscript.py

import shellshock as ss
ss.shell("""
if [ -f "file" ]; then
  echo "ok"
fi
""")

Then you could convert it to full Python shellscript syntax like so:

newscript.py

import shellshock as ss
if ss.isfile("file"):
    print("ok")

Full Documentation

To see more examples, CLI and library references, and extended documentation see the full docs at https://shellshock.readthedocs.io