Metadata-Version: 2.1
Name: magic-run-cmd
Version: 1.0.0
Summary: A simple interface to run a bash command from python. It wraps Popen, so  it's easier to run the command
License: Apache 2.0
Author: daniel davee
Author-email: daniel.v.davee@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: pysimplelog (>=4.0.0,<5.0.0)
Description-Content-Type: text/markdown

# run_cmd

This code is a simple wrapper for Popen to run shell commands from python. The required version of python is 3.8 or above.

## Installation:

### pip

You can install it via pip:

```
pip install run-cmd
```
### poetry

To install this code, you will need to first install Poetry (https://python-poetry.org/docs/#installation). Poetry is a dependency manager for Python that will allow you to easily install this code and its dependencies.

Once you have Poetry installed, you can install this code by running the following command from the root directory of this code:

```
poetry add run-cmd
```

This will install this code and all of its dependencies.

Usage:

To use this code, you can simply import the run_cmd function:

```python
from run_cmd.run_cmd import run_cmd

print(run_cmd('ls'))

output:
LICENSE  README.md  log/  poetry.lock  pyproject.toml  run_cmd/
```

Then, you can call the run_cmd function with a shell command as a string:


If an error thrown it caught, and logged before, erroring out.

You can also specify whether you want the output to be returned as a list or a string:

run_cmd('ls', split=True)

This will output the result as a list, with each element being one line of output.
