|PyPI version|

python-shellout
===============

Thin convenience wrappers for shelling out commands easily from python

Installation
------------

In shell with enough admin rights type

.. code:: bash

    $ git clone https://github.com/Chiel92/python-shellout
    $ cd python-shellout
    $ python3 setup.py install

Or to obtain the version from PyPI do

.. code:: bash

    $ pip install pyshellout

Example Usage
-------------

.. code:: python

    from pyshellout import get

    files=get(r'find . -name "*.cpp" -o -name "*.h" -print0')

    for f in files.z:
        print(f)
        matches=get(r"grep -zZ 'some regex pattern' '{filename}'", filename=f)
        print(matches.z)

A more elaborate example can be found on `this blog post about
automatically archiving merged git
branches. <http://ctenbrinke.net/2016/06/07/archiving-branches-with-git/>`__

.. |PyPI version| image:: https://badge.fury.io/py/pyshellout.svg
   :target: https://badge.fury.io/py/pyshellout
