Skip to main content

Write your shell scripts using Python

Project description

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

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

shellshock-0.0.1.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

shellshock-0.0.1-py3-none-any.whl (41.5 kB view details)

Uploaded Python 3

File details

Details for the file shellshock-0.0.1.tar.gz.

File metadata

  • Download URL: shellshock-0.0.1.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for shellshock-0.0.1.tar.gz
Algorithm Hash digest
SHA256 6eaea358bddc45b697213bf076a722af99aafe8a4233d041f856333e45fe55a4
MD5 0e1ad45713f20fb2c10ae1d90dc77a90
BLAKE2b-256 46cd510a30af9ece158c658c40ec25c020457dcda124171fb2788c15b09e1c30

See more details on using hashes here.

File details

Details for the file shellshock-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: shellshock-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 41.5 kB
  • Tags: Python 3
  • Uploaded using 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

File hashes

Hashes for shellshock-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 076961280910937f34ac49077be8018c58af6664e97ba643ccc9e8add9526296
MD5 411ed775087543aa91a1e1f09ffef4d9
BLAKE2b-256 d5cc873d3b446426c419eba7285d48bd43538882e41b45e04b7435469b189ed8

See more details on using hashes here.

Supported by

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