Pyshell

A python module for writing shell-scripts in Python. It introduces new functionality, bundles functions distributed over several modules of Python's standard library in one place and provides several auxiliary functions.

The function's provided by the shell module are named after the corresponding Unix commands.

Here's a quick demo:

from shell import *

rm('a/b/foo.txt')
mv('X.pdf', f'{HOME}/contents.pdf')

files = ls('Documents', '*.txt', '*.c')
magicFiles = run(['grep', 'magic'] + files, captureStdout=splitLines, onError='ignore').stdout

• Requirements: Python 3
• API documentation
• PyPI page
• Installation: pip install libPyshell

Changelog

• 0.6.6 (2026-07-01)

  • switch to static typing
  • make the package PEP 561-typed

• 0.5.0 (2025-03-11)

  • support of timeouts for run

• 0.4.1 (2024-09-12)

  • fix capture handling
  • add failOnError option to rm commands

• 0.4.0 (2024-03-20)

  • re-implement run in terms of subprocess.run. This fixes a bug that caused stdout to disappear.

• 0.3.0 (2024-02-01)

  • uniform treatment when capturing stdout and stderr. This lead to changes to RunResult and RunError which are slightly backwards incompatible.

• 0.2.0 (2024-01-29)

  • Better static type information

• 0.1.7 (2023-03-30)

  • force parameter for cp

• 0.1.5 and 0.1.6 (2023-03-03)

  • Some bugfixes

• 0.1.4 (2022-03-17)

  • Flush stdout and stderr before running a command