Skip to main content

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

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")

Metadata

Release files for shellshock 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for shellshock 0.0.1
File Size Uploaded
shellshock-0.0.1.tar.gz 11.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for shellshock 0.0.1
File Interpreter ABI Platform
shellshock-0.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 52.9 kB

Release files / shellshock-0.0.1.tar.gz

Download URL shellshock-0.0.1.tar.gz
Size 11.4 kB
Tags Source
SHA-256 checksum
How to use checksums
6eaea358bddc45b697213bf076a722af99aafe8a4233d041f856333e45fe55a4
BLAKE2b-256 checksum
How to use checksums
46cd510a30af9ece158c658c40ec25c020457dcda124171fb2788c15b09e1c30
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.6.3

Release files / shellshock-0.0.1-py3-none-any.whl

Download URL shellshock-0.0.1-py3-none-any.whl
Size 41.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
076961280910937f34ac49077be8018c58af6664e97ba643ccc9e8add9526296
BLAKE2b-256 checksum
How to use checksums
d5cc873d3b446426c419eba7285d48bd43538882e41b45e04b7435469b189ed8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.6.3

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page