https://github.com/jceaser/shellwrap

A set of helper functions for writing shell scripts with python
https://github.com/jceaser/shellwrap

python scripting shell

Last synced: 5 months ago
JSON representation

A set of helper functions for writing shell scripts with python

• Host: GitHub
• URL: https://github.com/jceaser/shellwrap
• Owner: jceaser
• Created: 2022-03-12T12:48:47.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-08-15T21:17:59.000Z (11 months ago)
• Last Synced: 2025-08-15T23:35:24.859Z (11 months ago)
• Topics: python, scripting, shell
• Language: Python
• Homepage:
• Size: 31.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Shell Wrap

A simple set of tools for writing shell scripts in python

## What this does

Far to much of the world runs on bash shell scripts. A shamefull amount of code, some of which I have contributed to. Shell scripts are just not the best language for most solutions. Python on the other hand is not is a bit more verbose when it comes to directly interacting with commands.

This library hopes to bridge that gap

## Setup for development

    get clone https://github.com/jceaser/shellwrap.git

    cd shellwrap

    pip3 install virtualenv

    virtualenv -p python3 .venv

    source .venv/bin/activate

    ./run.sh -I -b -i   #Init build install

    python3 example.py

## Installing directly

    pip3 install https://github.com/jceaser/shellwrap/releases/download/v0.0.3-release/shellwrap-0.0.3-py3-none-any.whl

## Usage

### Printing in color with formating

    from shellwrap import color

    color.cprint(color.tcode.green, "Starting script", env)

    print(color.colorize(":rocket::blink:This is my :red:RED:end: text and this is my :green:GREEN:end: text."))

    print(color.link("https://example.com/", "example.com"))

Read more about [OCS 8](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda).

### Calling Unix Commands

	from shellwrap import unix

	presult = unix.pipe(['echo', 'one', 'two', 'three'], ['wc', '-m'])

	print(unix.ccurl('-v',

		'-H', 'Header: Value',

		'https://github.com/jceaser/shellwrap.git'))

### Reading Files

	from shellwrap import file

	print(file.read_file('.editorconfig'))

### Interactivity

	from shellwrap import interactivity

	interactive.interactive(env, g=globals())

	interactive.user_commands(handler=process_actions, g=globals())

The function `interactivity()` will start a python shell with the scope of the `globals()` as the global for the session. This means that any public methods in the calling file are public in the session allowing for any of them to be run and interacted with. History is remembered.

The function `user_commands()` is a little different. This ones will prompt the user for commands which are then handled by `process_actions(action=None, env:dict=None)`. This allows the calling function more control over what actions are offered. History is also remembered.

----

Copyright © 2022-2025 Thomas Cherry. This software is declared to be under the BSD license.