python-shell 1.0.0

Python Shell Wrapper library

Python Shell Wrapper Library

A flexible, easy-to-use library to integrate your Python script with Unix ecosystems.

Why yet another one?

This library comes with a few major points to use it:

• It is easy and intuitive (see examples)
• It's compatible with Python 2 (can be useful in old large systems)
• Continuous support of the library

Getting started

This library is pretty easy to use:

from python_shell import Shell

Shell.ls('-l', '$HOME')  # Equals "ls -l $HOME"

command = Shell.whoami()  # Equals "whoami"
print(command.output)  # prints your current user name

print(command.command)  # prints "whoami"
print(command.return_code)  # prints "0"
print(command.arguments)  # prints ""

To run any Bash command, you need to do it like this:

Shell.<bash_command_name>(<bash command parameters>)

For example, you want to create a new folder:

Shell.mkdir('-p', '/tmp/new_folder')

Installing

Simply run

pip install python-shell

Extending the basic functionality

It's possible to extend the existing functionality without forking the project. The library provides an interface to add a custom Command class.

Running the tests

This library contains tests written using unittest module, so just run in the project directory

python -m unittest

Also it's possible to run tests using Tox:

tox -e <env>

Supported environments:

• py27
• py35
• py36
• py37
• py38
• coverage (using Python 3)
• coverage (using Python 2.7)
• pep8 (style checking)

Other old versions of Python (e.g. 2.6, 3.4, etc) will never be supported. However, you always can implement such support in your forks.

Authors

• Alex Sokolov - Author - Albartash

License

This project is licensed under the MIT License - see the LICENSE.md file for details.